diff --git a/src/OrderCloud.SDK/Generated/Models.cs b/src/OrderCloud.SDK/Generated/Models.cs index ebdb37e..5c0964e 100644 --- a/src/OrderCloud.SDK/Generated/Models.cs +++ b/src/OrderCloud.SDK/Generated/Models.cs @@ -207,8 +207,8 @@ public class ApiClient : OrderCloudModel public string AppName { get => GetProp("AppName"); set => SetProp("AppName", value); } /// Refresh token duration of the api client. Must be between 0 and 524160. public int RefreshTokenDuration { get => GetProp("RefreshTokenDuration"); set => SetProp("RefreshTokenDuration", value); } - /// Specifies the duration of anonymous tokens, expressed in minutes. This value is only used if the ApiClient is configured for anonymous shopping. The default is 10080 (7 days). - public int? AnonymousTokenDuration { get => GetProp("AnonymousTokenDuration"); set => SetProp("AnonymousTokenDuration", value); } + /// Specifies the duration of anonymous tokens, expressed in minutes. This value is only used if the ApiClient is configured for anonymous shopping. + public int? AnonymousTokenDuration { get => GetProp("AnonymousTokenDuration", 10080); set => SetProp("AnonymousTokenDuration", value); } /// Optionally set a user that will be used when authenticating with a Client Credentials grant type flow. This grant type is often used for anonymous browsing on buyer applications and authentication on server integration layers. public string DefaultContextUserName { get => GetProp("DefaultContextUserName"); set => SetProp("DefaultContextUserName", value); } /// Container for extended (custom) properties of the api client. @@ -1276,7 +1276,7 @@ public class InventoryRecord : OrderCloudModel public string ID { get => GetProp("ID"); set => SetProp("ID", value); } /// ID of the owner. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } - /// Allow inventory record to be used by all buyers in your Marketplace without creating explicit assignments, defaults to true. + /// Allow inventory record to be used by all buyers in your Marketplace without creating explicit assignments. public bool AllowAllBuyers { get => GetProp("AllowAllBuyers", true); set => SetProp("AllowAllBuyers", value); } /// Address of the inventory record. [ApiReadOnly] @@ -1629,8 +1629,8 @@ public class MessageSender : OrderCloudModel public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } /// ID of the delivery config. public string DeliveryConfigID { get => GetProp("DeliveryConfigID"); set => SetProp("DeliveryConfigID", value); } - /// Allow MessageSender to send to all buyers in your marketplace without creating explicit assignments, defaults to false. - public bool AllowAllBuyers { get => GetProp("AllowAllBuyers"); set => SetProp("AllowAllBuyers", value); } + /// Allow MessageSender to send to all buyers in your marketplace without creating explicit assignments. + public bool AllowAllBuyers { get => GetProp("AllowAllBuyers", false); set => SetProp("AllowAllBuyers", value); } } /// Specific type of the xp property. If not using a custom type, use the non-generic MessageSender class instead. public class MessageSender : MessageSender @@ -2712,7 +2712,7 @@ public class ProductFacet : OrderCloudModel public string XpPath { get => GetProp("XpPath"); set => SetProp("XpPath", value); } /// List order of the product facet. Sortable: priority level 1. public int ListOrder { get => GetProp("ListOrder"); set => SetProp("ListOrder", value); } - /// Minimum count required or a facet value to be returned in list metadata. Default is 1. If you want zero-count values returned, set this to 0. + /// Minimum count required or a facet value to be returned in list metadata. If you want zero-count values returned, set this to 0. public int MinCount { get => GetProp("MinCount", 1); set => SetProp("MinCount", value); } /// Container for extended (custom) properties of the product facet. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -2779,6 +2779,8 @@ public class ProductSyncConfig : OrderCloudModel public object ConfigData { get => GetProp("ConfigData"); set => SetProp("ConfigData", value); } /// Paused of the product sync config. public bool Paused { get => GetProp("Paused"); set => SetProp("Paused", value); } + /// Exclude price schedules of the product sync config. + public bool ExcludePriceSchedules { get => GetProp("ExcludePriceSchedules"); set => SetProp("ExcludePriceSchedules", value); } } public class Promotion : OrderCloudModel { @@ -3008,7 +3010,7 @@ public class SecurityProfile : OrderCloudModel public IList Roles { get => GetProp>("Roles", new List()); set => SetProp>("Roles", value); } /// Custom roles of the security profile. public IList CustomRoles { get => GetProp>("CustomRoles", new List()); set => SetProp>("CustomRoles", value); } - /// When PasswordConfig.ExpireInDays has a value, the user will be required to go through the PW reset flow once that number of days has passed. + /// Password config of the security profile. public PasswordConfig PasswordConfig { get => GetProp("PasswordConfig"); set => SetProp("PasswordConfig", value); } } public class SecurityProfileAssignment : OrderCloudModel @@ -3708,8 +3710,8 @@ public class VariantInventory : OrderCloudModel } public class VariantOverrides : OrderCloudModel { - /// Overrides the Active value inherited from the product when generating variants. Default is true. - public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } + /// Overrides the Active value inherited from the product when generating variants. + public bool Active { get => GetProp("Active", true); set => SetProp("Active", value); } } public class VariantSpec : OrderCloudModel { diff --git a/src/OrderCloud.SDK/Generated/Resources.cs b/src/OrderCloud.SDK/Generated/Resources.cs index 88213df..1f449f8 100644 --- a/src/OrderCloud.SDK/Generated/Resources.cs +++ b/src/OrderCloud.SDK/Generated/Resources.cs @@ -68,52 +68,52 @@ public partial interface IOrderCloudClient public interface IAddressesResource { - /// Get a single address. + /// Retrieve an address. /// ID of the buyer. /// ID of the address. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task
GetAsync(string buyerID, string addressID, string accessToken = null); - /// Get a single address. + /// Retrieve an address. /// ID of the buyer. /// ID of the address. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string addressID, string accessToken = null) where TAddress : Address; - /// Get a list of addresses. + /// List addresses. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of addresses. + /// List addresses. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TAddress : Address; - /// Get a list of addresses. + /// List addresses. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null); - /// Get a list of addresses. + /// List addresses. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null) where TAddress : Address; - /// Create a new address. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an address. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task
CreateAsync(string buyerID, Address address, string accessToken = null); - /// Create a new address. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an address. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -147,7 +147,7 @@ public interface IAddressesResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string buyerID, string addressID, PartialAddress partialAddress, string accessToken = null) where TAddress : Address; - /// Get a list of address assignments. + /// List address assignments. /// ID of the buyer. /// ID of the address. /// ID of the user. @@ -155,8 +155,8 @@ public interface IAddressesResource /// Level of the address assignment. Possible values: User, Group, Company. /// Is shipping of the address assignment. /// Is billing of the address assignment. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string buyerID, string addressID = null, string userID = null, string userGroupID = null, PartyType? level = null, bool? isShipping = null, bool? isBilling = null, int? page = null, int? pageSize = null, string accessToken = null); /// Delete an address assignment. @@ -175,45 +175,45 @@ public interface IAddressesResource public interface IAdminAddressesResource { - /// Get a single admin address. + /// Retrieve an admin address. /// ID of the address. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task
GetAsync(string addressID, string accessToken = null); - /// Get a single admin address. + /// Retrieve an admin address. /// ID of the address. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string addressID, string accessToken = null) where TAddress : Address; - /// Get a list of admin addresses. + /// List admin addresses. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of admin addresses. + /// List admin addresses. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TAddress : Address; - /// Get a list of admin addresses. + /// List admin addresses. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of admin addresses. + /// List admin addresses. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TAddress : Address; - /// Create a new admin address. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an admin address. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task
CreateAsync(Address address, string accessToken = null); - /// Create a new admin address. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an admin address. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Address address, string accessToken = null) where TAddress : Address; @@ -245,45 +245,45 @@ public interface IAdminAddressesResource public interface IAdminUserGroupsResource { - /// Get a single admin user group. + /// Retrieve an admin user group. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string userGroupID, string accessToken = null); - /// Get a single admin user group. + /// Retrieve an admin user group. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string userGroupID, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of admin user groups. + /// List admin user groups. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of admin user groups. + /// List admin user groups. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of admin user groups. + /// List admin user groups. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of admin user groups. + /// List admin user groups. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TUserGroup : UserGroup; - /// Create a new admin user group. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an admin user group. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(UserGroup userGroup, string accessToken = null); - /// Create a new admin user group. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an admin user group. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(UserGroup userGroup, string accessToken = null) where TUserGroup : UserGroup; @@ -311,11 +311,11 @@ public interface IAdminUserGroupsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string userGroupID, PartialUserGroup partialUserGroup, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of admin user group user assignments. + /// List admin user group user assignments. /// ID of the user group. /// ID of the user. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListUserAssignmentsAsync(string userGroupID = null, string userID = null, int page = 1, int pageSize = 20, string accessToken = null); /// Delete an admin user group user assignment. @@ -331,45 +331,45 @@ public interface IAdminUserGroupsResource public interface IAdminUsersResource { - /// Get a single admin user. + /// Retrieve an admin user. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string userID, string accessToken = null); - /// Get a single admin user. + /// Retrieve an admin user. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string userID, string accessToken = null) where TUser : User; - /// Get a list of admin users. + /// List admin users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of admin users. + /// List admin users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUser : User; - /// Get a list of admin users. + /// List admin users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of admin users. + /// List admin users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TUser : User; - /// Create a new admin user. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an admin user. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(User user, string accessToken = null); - /// Create a new admin user. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an admin user. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(User user, string accessToken = null) where TUser : User; @@ -397,11 +397,11 @@ public interface IAdminUsersResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string userID, PartialUser partialUser, string accessToken = null) where TUser : User; - /// Unlock a user account. + /// Unlock a user account /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task UnlockUserAccountAsync(string userID, string accessToken = null); - /// Revoke a user tokens. Revokes all security tokens of specified user. + /// Revoke a user tokens Revokes all security tokens of specified user. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task RevokeUserTokensAsync(string userID, string accessToken = null); @@ -409,126 +409,126 @@ public interface IAdminUsersResource public interface IApiClientsResource { - /// Get a single API client. + /// Retrieve an API client. /// ID of the api client. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string apiClientID, string accessToken = null); - /// Get a single API client. + /// Retrieve an API client. /// ID of the api client. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string apiClientID, string accessToken = null) where TApiClient : ApiClient; - /// Get a list of API clients. + /// List API clients. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of API clients. + /// List API clients. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TApiClient : ApiClient; - /// Get a list of API clients. + /// List API clients. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of API clients. + /// List API clients. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TApiClient : ApiClient; - /// Create a new API client. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an API client. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(ApiClient apiClient, string accessToken = null); - /// Create a new API client. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an API client. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(ApiClient apiClient, string accessToken = null) where TApiClient : ApiClient; - /// Update an API client. If an object with the same ID already exists, it will be overwritten. + /// Create or update an API client. If an object with the same ID already exists, it will be overwritten. /// ID of the api client. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAsync(string apiClientID, ApiClient apiClient, string accessToken = null); - /// Update an API client. If an object with the same ID already exists, it will be overwritten. + /// Create or update an API client. If an object with the same ID already exists, it will be overwritten. /// ID of the api client. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAsync(string apiClientID, ApiClient apiClient, string accessToken = null) where TApiClient : ApiClient; - /// Delete a API client. + /// Delete an API client. /// ID of the api client. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAsync(string apiClientID, string accessToken = null); - /// Get a list of API client assignments. + /// List API client assignments. /// ID of the api client. /// ID of the buyer. /// ID of the supplier. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string apiClientID = null, string buyerID = null, string supplierID = null, int page = 1, int pageSize = 20, string accessToken = null); - /// Partially update a API client. + /// Partially update an API client. /// ID of the api client. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string apiClientID, PartialApiClient partialApiClient, string accessToken = null); - /// Partially update a API client. + /// Partially update an API client. /// ID of the api client. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string apiClientID, PartialApiClient partialApiClient, string accessToken = null) where TApiClient : ApiClient; - /// Create or update a API client assignment. + /// Create or update an API client assignment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAssignmentAsync(ApiClientAssignment apiClientAssignment, string accessToken = null); - /// Delete a API client buyer assignment. + /// Delete an API client buyer assignment. /// ID of the api client. /// ID of the buyer. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteBuyerAssignmentAsync(string apiClientID, string buyerID, string accessToken = null); - /// Delete a API client supplier assignment. + /// Delete an API client supplier assignment. /// ID of the api client. /// ID of the supplier. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteSupplierAssignmentAsync(string apiClientID, string supplierID, string accessToken = null); - /// Get a single API client secret. + /// Retrieve an API client secret. /// ID of the api client. /// ID of the api client secret. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSecretAsync(string apiClientID, string apiClientSecretID, string accessToken = null); - /// Get a list of API client secrets. + /// List API client secrets. /// ID of the api client. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSecretsAsync(string apiClientID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of API client secrets. + /// List API client secrets. /// ID of the api client. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSecretsAsync(string apiClientID, Action> buildListOpts, string accessToken = null); - /// Create a new API client secret. + /// Create an API client secret. /// ID of the api client. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateSecretAsync(string apiClientID, ApiClientSecret apiClientSecret, string accessToken = null); - /// Partially update a API client secret. + /// Partially update an API client secret. /// ID of the api client. /// ID of the api client secret. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchSecretAsync(string apiClientID, string apiClientSecretID, PartialApiClientSecret partialApiClientSecret, string accessToken = null); - /// Delete a API client secret. + /// Delete an API client secret. /// ID of the api client. /// ID of the api client secret. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -537,52 +537,52 @@ public interface IApiClientsResource public interface IApprovalRulesResource { - /// Get a single approval rule. + /// Retrieve an approval rule. /// ID of the buyer. /// ID of the approval rule. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string approvalRuleID, string accessToken = null); - /// Get a single approval rule. + /// Retrieve an approval rule. /// ID of the buyer. /// ID of the approval rule. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string approvalRuleID, string accessToken = null) where TApprovalRule : ApprovalRule; - /// Get a list of approval rules. + /// List approval rules. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of approval rules. + /// List approval rules. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TApprovalRule : ApprovalRule; - /// Get a list of approval rules. + /// List approval rules. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null); - /// Get a list of approval rules. + /// List approval rules. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null) where TApprovalRule : ApprovalRule; - /// Create a new approval rule. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an approval rule. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string buyerID, ApprovalRule approvalRule, string accessToken = null); - /// Create a new approval rule. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an approval rule. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -620,22 +620,22 @@ public interface IApprovalRulesResource public interface IBundleLineItemsResource { - /// Create a new bundle line item. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a bundle line item. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the bundle. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderDirection direction, string orderID, string bundleID, BundleItems bundleItems = null, string accessToken = null); - /// Create a new bundle line item. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a bundle line item. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the bundle. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderDirection direction, string orderID, string bundleID, BundleItems bundleItems = null, string accessToken = null) where TLineItem : LineItem; /// Delete a bundle line item. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the bundle. /// ID of the bundle item. @@ -645,59 +645,59 @@ public interface IBundleLineItemsResource public interface IBundlesResource { - /// Get a single bundle. + /// Retrieve a bundle. /// ID of the bundle. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string bundleID, string accessToken = null); - /// Get a single bundle. + /// Retrieve a bundle. /// ID of the bundle. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string bundleID, string accessToken = null) where TBundle : Bundle; - /// Get a list of bundles. + /// List bundles. /// ID of the catalog. /// ID of the category. /// ID of the supplier. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string catalogID = null, string categoryID = null, string supplierID = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of bundles. + /// List bundles. /// ID of the catalog. /// ID of the category. /// ID of the supplier. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string catalogID = null, string categoryID = null, string supplierID = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TBundle : Bundle; - /// Get a list of bundles. + /// List bundles. /// A lambda or function for specifying various list options fluently. /// ID of the catalog. /// ID of the category. /// ID of the supplier. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string catalogID = null, string categoryID = null, string supplierID = null, string accessToken = null); - /// Get a list of bundles. + /// List bundles. /// A lambda or function for specifying various list options fluently. /// ID of the catalog. /// ID of the category. /// ID of the supplier. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string catalogID = null, string categoryID = null, string supplierID = null, string accessToken = null) where TBundle : Bundle; - /// Create a new bundle. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a bundle. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Bundle bundle, string accessToken = null); - /// Create a new bundle. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a bundle. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Bundle bundle, string accessToken = null) where TBundle : Bundle; @@ -729,11 +729,11 @@ public interface IBundlesResource /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveProductAssignmentAsync(BundleProductAssignment bundleProductAssignment, string accessToken = null); - /// Get a list of bundle product assignments. + /// List bundle product assignments. /// ID of the bundle. /// ID of the product. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductAssignmentsAsync(string bundleID = null, string productID = null, int page = 1, int pageSize = 20, string accessToken = null); /// Delete a bundle product assignment. @@ -741,14 +741,14 @@ public interface IBundlesResource /// ID of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteProductAssignmentAsync(string bundleID, string productID, string accessToken = null); - /// Get a list of bundle assignments. + /// List bundle assignments. /// ID of the bundle. /// ID of the buyer. /// ID of the user. /// ID of the user group. /// Level of the bundle assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string bundleID = null, string buyerID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Create or update a bundle assignment. @@ -767,13 +767,13 @@ public interface IBundlesResource public interface IBundleSubscriptionItemsResource { - /// Create a new bundle subscription item. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a bundle subscription item. /// ID of the subscription. /// ID of the bundle. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string subscriptionID, string bundleID, BundleItems bundleItems = null, string accessToken = null); - /// Create a new bundle subscription item. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a bundle subscription item. /// ID of the subscription. /// ID of the bundle. /// The object that will be serialized to JSON and sent in the request body. @@ -789,45 +789,45 @@ public interface IBundleSubscriptionItemsResource public interface IBuyersResource { - /// Get a single buyer. + /// Retrieve a buyer. /// ID of the buyer. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string accessToken = null); - /// Get a single buyer. + /// Retrieve a buyer. /// ID of the buyer. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string accessToken = null) where TBuyer : Buyer; - /// Get a list of buyers. + /// List buyers. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of buyers. + /// List buyers. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TBuyer : Buyer; - /// Get a list of buyers. + /// List buyers. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of buyers. + /// List buyers. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TBuyer : Buyer; - /// Create a new buyer. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Buyer buyer, string accessToken = null); - /// Create a new buyer. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Buyer buyer, string accessToken = null) where TBuyer : Buyer; @@ -855,17 +855,17 @@ public interface IBuyersResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string buyerID, PartialBuyer partialBuyer, string accessToken = null) where TBuyer : Buyer; - /// Get a list of buyer buyer sellers. + /// List sellers this buyer can purchase from /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListBuyerSellersAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of buyer buyer sellers. + /// List sellers this buyer can purchase from /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -874,10 +874,10 @@ public interface IBuyersResource public interface ICartResource { - /// Get a single cart. If the ID of the Order returned is null, the cart has not yet been interacted with. Once an item is added, the Order.ID will be populated. + /// Retrieve a cart. If the ID of the Order returned is null, the cart has not yet been interacted with. Once an item is added, the Order.ID will be populated. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null); - /// Get a single cart. If the ID of the Order returned is null, the cart has not yet been interacted with. Once an item is added, the Order.ID will be populated. + /// Retrieve a cart. If the ID of the Order returned is null, the cart has not yet been interacted with. Once an item is added, the Order.ID will be populated. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null) where TOrder : Order; /// Create or update a cart. If an object with the same ID already exists, it will be overwritten. @@ -891,7 +891,7 @@ public interface ICartResource /// Delete a cart. Empties the cart. Any promotions, payments or other items associated with the cart will also be removed. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAsync(string accessToken = null); - /// Set an active cart. + /// Set an active cart /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetActiveCartAsync(string orderID, string accessToken = null); @@ -903,45 +903,45 @@ public interface ICartResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(PartialOrder partialOrder, string accessToken = null) where TOrder : Order; - /// Get a list of cart line items. + /// List cart line items. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListLineItemsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of cart line items. + /// List cart line items. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListLineItemsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TLineItem : LineItem; - /// Get a list of cart line items. + /// List cart line items. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListLineItemsAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of cart line items. + /// List cart line items. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListLineItemsAsync(Action> buildListOpts, string accessToken = null) where TLineItem : LineItem; - /// Get a single cart line item. + /// Retrieve a cart line item. /// ID of the line item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetLineItemAsync(string lineItemID, string accessToken = null); - /// Get a single cart line item. + /// Retrieve a cart line item. /// ID of the line item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetLineItemAsync(string lineItemID, string accessToken = null) where TLineItem : LineItem; - /// Create a new cart line item. Adds a line item to the cart + /// Create a cart line item. Adds a line item to the cart /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateLineItemAsync(LineItem lineItem, string accessToken = null); - /// Create a new cart line item. Adds a line item to the cart + /// Create a cart line item. Adds a line item to the cart /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateLineItemAsync(LineItem lineItem, string accessToken = null) where TLineItem : LineItem; @@ -969,12 +969,12 @@ public interface ICartResource /// ID of the line item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteLineItemAsync(string lineItemID, string accessToken = null); - /// Create a new cart bundle item. Adds bundle line items to the cart + /// Create a cart bundle item. Adds bundle line items to the cart /// ID of the bundle. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateBundleItemAsync(string bundleID, BundleItems bundleItems = null, string accessToken = null); - /// Create a new cart bundle item. Adds bundle line items to the cart + /// Create a cart bundle item. Adds bundle line items to the cart /// ID of the bundle. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -984,63 +984,63 @@ public interface ICartResource /// ID of the bundle item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteBundleItemAsync(string bundleID, string bundleItemID, string accessToken = null); - /// Get a list of cart promotions. + /// List cart promotions. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of cart promotions. + /// List cart promotions. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TOrderPromotion : OrderPromotion; - /// Get a list of cart promotions. + /// List cart promotions. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of cart promotions. + /// List cart promotions. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(Action> buildListOpts, string accessToken = null) where TOrderPromotion : OrderPromotion; - /// List eligible promotions. Get a list of promotions eligible for the cart. + /// List eligible promotions for the cart /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligiblePromotionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// List eligible promotions. Get a list of promotions eligible for the cart. + /// List eligible promotions for the cart /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligiblePromotionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TEligiblePromotion : EligiblePromotion; - /// List eligible promotions. Get a list of promotions eligible for the cart. + /// List eligible promotions for the cart /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligiblePromotionsAsync(Action> buildListOpts, string accessToken = null); - /// List eligible promotions. Get a list of promotions eligible for the cart. + /// List eligible promotions for the cart /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligiblePromotionsAsync(Action> buildListOpts, string accessToken = null) where TEligiblePromotion : EligiblePromotion; - /// Add a promotion. + /// Add a promotion /// Promo code of the order promotion. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task AddPromotionAsync(string promoCode, string accessToken = null); - /// Add a promotion. + /// Add a promotion /// Promo code of the order promotion. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task AddPromotionAsync(string promoCode, string accessToken = null) where TOrderPromotion : OrderPromotion; @@ -1048,65 +1048,65 @@ public interface ICartResource /// Promo code of the cart. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeletePromotionAsync(string promoCode, string accessToken = null); - /// Auto-apply promotions to the cart. Apply up to 100 eligible promotions where AutoApply=true. + /// Auto-apply promotions to the cart Apply up to 100 eligible promotions where AutoApply=true. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ApplyPromotionsAsync(string accessToken = null); - /// Auto-apply promotions to the cart. Apply up to 100 eligible promotions where AutoApply=true. + /// Auto-apply promotions to the cart Apply up to 100 eligible promotions where AutoApply=true. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ApplyPromotionsAsync(string accessToken = null) where TOrder : Order; - /// Refresh promotions on the cart. Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100) + /// Refresh promotions on the cart Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100) /// Optional. Use to provide an existing token instead of authenticating implicitly. Task RefreshPromotionsAsync(string accessToken = null); - /// Refresh promotions on the cart. Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100) + /// Refresh promotions on the cart Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100) /// Optional. Use to provide an existing token instead of authenticating implicitly. Task RefreshPromotionsAsync(string accessToken = null) where TRefreshPromosResponse : RefreshPromosResponse; - /// Update cart FromUser. Only FirstName, LastName, and Email can be updated. Primarily used to facilitate guest checkout scenarios. + /// Partially update a cart from user. Only FirstName, LastName, and Email can be updated. Primarily used to facilitate guest checkout scenarios. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchFromUserAsync(PartialUser partialUser, string accessToken = null); - /// Update cart FromUser. Only FirstName, LastName, and Email can be updated. Primarily used to facilitate guest checkout scenarios. + /// Partially update a cart from user. Only FirstName, LastName, and Email can be updated. Primarily used to facilitate guest checkout scenarios. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchFromUserAsync(PartialUser partialUser, string accessToken = null) where TOrder : Order; - /// Get a list of cart payments. + /// List cart payments. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPaymentsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of cart payments. + /// List cart payments. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPaymentsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TPayment : Payment; - /// Get a list of cart payments. + /// List cart payments. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPaymentsAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of cart payments. + /// List cart payments. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPaymentsAsync(Action> buildListOpts, string accessToken = null) where TPayment : Payment; - /// Get a single cart payment. + /// Retrieve a cart payment. /// ID of the payment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetPaymentAsync(string paymentID, string accessToken = null); - /// Get a single cart payment. + /// Retrieve a cart payment. /// ID of the payment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetPaymentAsync(string paymentID, string accessToken = null) where TPayment : Payment; - /// Create a new cart payment. + /// Create a cart payment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreatePaymentAsync(Payment payment, string accessToken = null); - /// Create a new cart payment. + /// Create a cart payment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreatePaymentAsync(Payment payment, string accessToken = null) where TPayment : Payment; @@ -1124,12 +1124,12 @@ public interface ICartResource /// ID of the payment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeletePaymentAsync(string paymentID, string accessToken = null); - /// Create a new cart payment transaction. + /// Create a cart payment transaction. /// ID of the payment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreatePaymentTransactionAsync(string paymentID, PaymentTransaction paymentTransaction, string accessToken = null); - /// Create a new cart payment transaction. + /// Create a cart payment transaction. /// ID of the payment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -1139,46 +1139,46 @@ public interface ICartResource /// ID of the transaction. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeletePaymentTransactionAsync(string paymentID, string transactionID, string accessToken = null); - /// Submit the cart. + /// Submit the cart /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SubmitAsync(string accessToken = null); - /// Submit the cart. + /// Submit the cart /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SubmitAsync(string accessToken = null) where TOrder : Order; - /// Validate the cart in it's current state. + /// Validate the cart in it's current state /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ValidateAsync(string accessToken = null); - /// Calculate the cart. + /// Calculate the cart /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CalculateAsync(string accessToken = null); - /// Calculate the cart. + /// Calculate the cart /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CalculateAsync(string accessToken = null) where TOrderWorksheet : OrderWorksheet; - /// Get a single cart order worksheet. + /// Retrieve a cart order worksheet. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetOrderWorksheetAsync(string accessToken = null); - /// Get a single cart order worksheet. + /// Retrieve a cart order worksheet. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetOrderWorksheetAsync(string accessToken = null) where TOrderWorksheet : OrderWorksheet; - /// Estimate shipping cost. + /// Estimate shipping cost /// Optional. Use to provide an existing token instead of authenticating implicitly. Task EstimateShippingAsync(string accessToken = null); - /// Estimate shipping cost. + /// Estimate shipping cost /// Optional. Use to provide an existing token instead of authenticating implicitly. Task EstimateShippingAsync(string accessToken = null) where TOrderWorksheet : OrderWorksheet; - /// Select a ship method. + /// Select a ship method /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SelectShipMethodsAsync(OrderShipMethodSelection orderShipMethodSelection, string accessToken = null); - /// Select a ship method. + /// Select a ship method /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SelectShipMethodsAsync(OrderShipMethodSelection orderShipMethodSelection, string accessToken = null) where TOrderWorksheet : OrderWorksheet; - /// Set a shipping address. + /// Set a shipping address /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShippingAddressAsync(Address address, string accessToken = null); - /// Set a shipping address. + /// Set a shipping address /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShippingAddressAsync(Address address, string accessToken = null) where TOrder : Order; @@ -1190,11 +1190,11 @@ public interface ICartResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchShippingAddressAsync(PartialAddress partialAddress, string accessToken = null) where TOrder : Order; - /// Set a billing address. Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead. + /// Set a billing address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetBillingAddressAsync(Address address, string accessToken = null); - /// Set a billing address. Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead. + /// Set a billing address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetBillingAddressAsync(Address address, string accessToken = null) where TOrder : Order; @@ -1210,45 +1210,45 @@ public interface ICartResource public interface ICatalogsResource { - /// Get a single catalog. + /// Retrieve a catalog. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string catalogID, string accessToken = null); - /// Get a single catalog. + /// Retrieve a catalog. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string catalogID, string accessToken = null) where TCatalog : Catalog; - /// Get a list of catalogs. + /// List catalogs. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of catalogs. + /// List catalogs. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TCatalog : Catalog; - /// Get a list of catalogs. + /// List catalogs. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of catalogs. + /// List catalogs. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TCatalog : Catalog; - /// Create a new catalog. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a catalog. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Catalog catalog, string accessToken = null); - /// Create a new catalog. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a catalog. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Catalog catalog, string accessToken = null) where TCatalog : Catalog; @@ -1276,11 +1276,11 @@ public interface ICatalogsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string catalogID, PartialCatalog partialCatalog, string accessToken = null) where TCatalog : Catalog; - /// Get a list of catalog assignments. + /// List catalog assignments. /// ID of the catalog. /// ID of the buyer. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string catalogID = null, string buyerID = null, int page = 1, int pageSize = 20, string accessToken = null); /// Create or update a catalog assignment. @@ -1292,11 +1292,11 @@ public interface ICatalogsResource /// ID of the buyer. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAssignmentAsync(string catalogID, string buyerID, string accessToken = null); - /// Get a list of catalog product assignments. + /// List catalog product assignments. /// ID of the catalog. /// ID of the product. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductAssignmentsAsync(string catalogID = null, string productID = null, int page = 1, int pageSize = 20, string accessToken = null); /// Create or update a catalog product assignment. @@ -1308,11 +1308,11 @@ public interface ICatalogsResource /// ID of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteProductAssignmentAsync(string catalogID, string productID, string accessToken = null); - /// Get a list of catalog bundle assignments. + /// List catalog bundle assignments. /// ID of the catalog. /// ID of the bundle. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListBundleAssignmentsAsync(string catalogID = null, string bundleID = null, int page = 1, int pageSize = 20, string accessToken = null); /// Create or update a catalog bundle assignment. @@ -1328,57 +1328,57 @@ public interface ICatalogsResource public interface ICategoriesResource { - /// Get a single category. + /// Retrieve a category. /// ID of the catalog. /// ID of the category. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string catalogID, string categoryID, string accessToken = null); - /// Get a single category. + /// Retrieve a category. /// ID of the catalog. /// ID of the category. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string catalogID, string categoryID, string accessToken = null) where TCategory : Category; - /// Get a list of categories. + /// List categories. /// ID of the catalog. /// Depth of the category. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string catalogID, string depth = "1", string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of categories. + /// List categories. /// ID of the catalog. /// Depth of the category. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string catalogID, string depth = "1", string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TCategory : Category; - /// Get a list of categories. + /// List categories. /// ID of the catalog. /// A lambda or function for specifying various list options fluently. /// Depth of the category. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string catalogID, Action> buildListOpts, string depth = "1", string accessToken = null); - /// Get a list of categories. + /// List categories. /// ID of the catalog. /// A lambda or function for specifying various list options fluently. /// Depth of the category. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string catalogID, Action> buildListOpts, string depth = "1", string accessToken = null) where TCategory : Category; - /// Create a new category. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a category. Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder. /// ID of the catalog. /// The object that will be serialized to JSON and sent in the request body. /// Adjust list orders of the category. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string catalogID, Category category, bool adjustListOrders = false, string accessToken = null); - /// Create a new category. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a category. Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder. /// ID of the catalog. /// The object that will be serialized to JSON and sent in the request body. /// Adjust list orders of the category. @@ -1417,15 +1417,15 @@ public interface ICategoriesResource /// Adjust list orders of the partial 1. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string catalogID, string categoryID, PartialCategory partialCategory, bool adjustListOrders = false, string accessToken = null) where TCategory : Category; - /// Get a list of category assignments. + /// List category assignments. /// ID of the catalog. /// ID of the category. /// ID of the buyer. /// ID of the user. /// ID of the user group. /// Level of the category assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string catalogID, string categoryID = null, string buyerID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Delete a category assignment. @@ -1441,12 +1441,12 @@ public interface ICategoriesResource /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAssignmentAsync(string catalogID, CategoryAssignment categoryAssignment, string accessToken = null); - /// Get a list of category product assignments. + /// List category product assignments. /// ID of the catalog. /// ID of the category. /// ID of the product. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductAssignmentsAsync(string catalogID, string categoryID = null, string productID = null, int page = 1, int pageSize = 20, string accessToken = null); /// Create or update a category product assignment. @@ -1460,12 +1460,12 @@ public interface ICategoriesResource /// ID of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteProductAssignmentAsync(string catalogID, string categoryID, string productID, string accessToken = null); - /// Get a list of category bundle assignments. + /// List category bundle assignments. /// ID of the catalog. /// ID of the category. /// ID of the bundle. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListBundleAssignmentsAsync(string catalogID, string categoryID = null, string bundleID = null, int page = 1, int pageSize = 20, string accessToken = null); /// Create or update a category bundle assignment. @@ -1483,52 +1483,52 @@ public interface ICategoriesResource public interface ICostCentersResource { - /// Get a single cost center. + /// Retrieve a cost center. /// ID of the buyer. /// ID of the cost center. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string costCenterID, string accessToken = null); - /// Get a single cost center. + /// Retrieve a cost center. /// ID of the buyer. /// ID of the cost center. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string costCenterID, string accessToken = null) where TCostCenter : CostCenter; - /// Get a list of cost centers. + /// List cost centers. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of cost centers. + /// List cost centers. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TCostCenter : CostCenter; - /// Get a list of cost centers. + /// List cost centers. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null); - /// Get a list of cost centers. + /// List cost centers. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null) where TCostCenter : CostCenter; - /// Create a new cost center. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a cost center. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string buyerID, CostCenter costCenter, string accessToken = null); - /// Create a new cost center. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a cost center. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -1562,14 +1562,14 @@ public interface ICostCentersResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string buyerID, string costCenterID, PartialCostCenter partialCostCenter, string accessToken = null) where TCostCenter : CostCenter; - /// Get a list of cost center assignments. + /// List cost center assignments. /// ID of the buyer. /// ID of the cost center. /// ID of the user. /// ID of the user group. /// Level of the cost center assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string buyerID, string costCenterID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Delete a cost center assignment. @@ -1588,52 +1588,52 @@ public interface ICostCentersResource public interface ICreditCardsResource { - /// Get a single credit card. + /// Retrieve a credit card. /// ID of the buyer. /// ID of the credit card. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string creditCardID, string accessToken = null); - /// Get a single credit card. + /// Retrieve a credit card. /// ID of the buyer. /// ID of the credit card. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string creditCardID, string accessToken = null) where TCreditCard : CreditCard; - /// Get a list of credit cards. + /// List credit cards. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of credit cards. + /// List credit cards. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TCreditCard : CreditCard; - /// Get a list of credit cards. + /// List credit cards. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null); - /// Get a list of credit cards. + /// List credit cards. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null) where TCreditCard : CreditCard; - /// Create a new credit card. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a credit card. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string buyerID, CreditCard creditCard, string accessToken = null); - /// Create a new credit card. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a credit card. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -1667,14 +1667,14 @@ public interface ICreditCardsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string buyerID, string creditCardID, PartialCreditCard partialCreditCard, string accessToken = null) where TCreditCard : CreditCard; - /// Get a list of credit card assignments. + /// List credit card assignments. /// ID of the buyer. /// ID of the credit card. /// ID of the user. /// ID of the user group. /// Level of the credit card assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string buyerID, string creditCardID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Create or update a credit card assignment. @@ -1693,24 +1693,24 @@ public interface ICreditCardsResource public interface IDeliveryConfigurationsResource { - /// Get a single delivery configuration. + /// Retrieve a delivery configuration. /// ID of the delivery config. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string deliveryConfigID, string accessToken = null); - /// Get a list of delivery configurations. + /// List delivery configurations. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of delivery configurations. + /// List delivery configurations. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Create a new delivery configuration. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a delivery configuration. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(DeliveryConfig deliveryConfig, string accessToken = null); @@ -1732,147 +1732,147 @@ public interface IDeliveryConfigurationsResource public interface IEntitySyncsResource { - /// Get the entity sync delivery configuration for Categories Get the entity sync delivery configuration for Categories + /// Retrieve the entity sync delivery configuration for categories Get the entity sync delivery configuration for Categories /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetCategoriesAsync(string accessToken = null); - /// Delete the entity sync delivery configuration for Categories Delete the entity sync delivery configuration for Categories + /// Delete the entity sync delivery configuration for categories Delete the entity sync delivery configuration for Categories /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteCategoriesAsync(string accessToken = null); - /// Create or update the entity sync delivery configuration for Categories Create or update the entity sync delivery configuration for Categories + /// Create or update the entity sync delivery configuration for categories Create or update the entity sync delivery configuration for Categories /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveCategoriesAsync(EntitySyncConfig entitySyncConfig, string accessToken = null); - /// Partially update the entity sync delivery configuration for Categories Partially update the entity sync delivery configuration for Categories + /// Partially update the entity sync delivery configuration for categories Partially update the entity sync delivery configuration for Categories /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchCategoriesAsync(PartialEntitySyncConfig partialEntitySyncConfig, string accessToken = null); - /// Sync a category. + /// Sync a category /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SyncCategoryAsync(SyncCategory syncCategory, string accessToken = null); - /// Get the entity sync delivery configuration for Suppliers Get the entity sync delivery configuration for Suppliers + /// Retrieve the entity sync delivery configuration for suppliers Get the entity sync delivery configuration for Suppliers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSuppliersAsync(string accessToken = null); - /// Delete the entity sync delivery configuration for Suppliers Delete the entity sync delivery configuration for Suppliers + /// Delete the entity sync delivery configuration for suppliers Delete the entity sync delivery configuration for Suppliers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteSuppliersAsync(string accessToken = null); - /// Create or update the entity sync delivery configuration for Suppliers Create or update the entity sync delivery configuration for Suppliers + /// Create or update the entity sync delivery configuration for suppliers Create or update the entity sync delivery configuration for Suppliers /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveSuppliersAsync(EntitySyncConfig entitySyncConfig, string accessToken = null); - /// Partially update the entity sync delivery configuration for Suppliers Partially update the entity sync delivery configuration for Suppliers + /// Partially update the entity sync delivery configuration for suppliers Partially update the entity sync delivery configuration for Suppliers /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchSuppliersAsync(PartialEntitySyncConfig partialEntitySyncConfig, string accessToken = null); - /// Sync a supplier. + /// Sync a supplier /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SyncSupplierAsync(SyncSupplier syncSupplier, string accessToken = null); - /// Get the entity sync delivery configuration for BuyerUsers Get the entity sync delivery configuration for BuyerUsers + /// Retrieve the entity sync delivery configuration for buyer users Get the entity sync delivery configuration for BuyerUsers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetBuyerUsersAsync(string accessToken = null); - /// Delete the entity sync delivery configuration for BuyerUsers Delete the entity sync delivery configuration for BuyerUsers + /// Delete the entity sync delivery configuration for buyer users Delete the entity sync delivery configuration for BuyerUsers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteBuyerUsersAsync(string accessToken = null); - /// Create or update the entity sync delivery configuration for BuyerUsers Create or update the entity sync delivery configuration for BuyerUsers + /// Create or update the entity sync delivery configuration for buyer users Create or update the entity sync delivery configuration for BuyerUsers /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveBuyerUsersAsync(EntitySyncConfig entitySyncConfig, string accessToken = null); - /// Partially update the entity sync delivery configuration for BuyerUsers Partially update the entity sync delivery configuration for BuyerUsers + /// Partially update the entity sync delivery configuration for buyer users Partially update the entity sync delivery configuration for BuyerUsers /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchBuyerUsersAsync(PartialEntitySyncConfig partialEntitySyncConfig, string accessToken = null); - /// Sync a buyer user. + /// Sync a buyer user /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SyncBuyerUserAsync(SyncBuyerUser syncBuyerUser, string accessToken = null); - /// Get the entity sync delivery configuration for SupplierUsers Get the entity sync delivery configuration for SupplierUsers + /// Retrieve the entity sync delivery configuration for supplier users Get the entity sync delivery configuration for SupplierUsers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSupplierUsersAsync(string accessToken = null); - /// Delete the entity sync delivery configuration for SupplierUsers Delete the entity sync delivery configuration for SupplierUsers + /// Delete the entity sync delivery configuration for supplier users Delete the entity sync delivery configuration for SupplierUsers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteSupplierUsersAsync(string accessToken = null); - /// Create or update the entity sync delivery configuration for SupplierUsers Create or update the entity sync delivery configuration for SupplierUsers + /// Create or update the entity sync delivery configuration for supplier users Create or update the entity sync delivery configuration for SupplierUsers /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveSupplierUsersAsync(EntitySyncConfig entitySyncConfig, string accessToken = null); - /// Partially update the entity sync delivery configuration for SupplierUsers Partially update the entity sync delivery configuration for SupplierUsers + /// Partially update the entity sync delivery configuration for supplier users Partially update the entity sync delivery configuration for SupplierUsers /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchSupplierUsersAsync(PartialEntitySyncConfig partialEntitySyncConfig, string accessToken = null); - /// Sync a supplier user. + /// Sync a supplier user /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SyncSupplierUserAsync(SyncSupplierUser syncSupplierUser, string accessToken = null); - /// Get the entity sync delivery configuration for AdminUsers Get the entity sync delivery configuration for AdminUsers + /// Retrieve the entity sync delivery configuration for admin users Get the entity sync delivery configuration for AdminUsers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAdminUsersAsync(string accessToken = null); - /// Delete the entity sync delivery configuration for AdminUsers Delete the entity sync delivery configuration for AdminUsers + /// Delete the entity sync delivery configuration for admin users Delete the entity sync delivery configuration for AdminUsers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAdminUsersAsync(string accessToken = null); - /// Create or update the entity sync delivery configuration for AdminUsers Create or update the entity sync delivery configuration for AdminUsers + /// Create or update the entity sync delivery configuration for admin users Create or update the entity sync delivery configuration for AdminUsers /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAdminUsersAsync(EntitySyncConfig entitySyncConfig, string accessToken = null); - /// Partially update the entity sync delivery configuration for AdminUsers Partially update the entity sync delivery configuration for AdminUsers + /// Partially update the entity sync delivery configuration for admin users Partially update the entity sync delivery configuration for AdminUsers /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAdminUsersAsync(PartialEntitySyncConfig partialEntitySyncConfig, string accessToken = null); - /// Sync an admin user. + /// Sync an admin user /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SyncAdminUserAsync(SyncAdminUser syncAdminUser, string accessToken = null); - /// Get the entity sync delivery configuration for Buyers Get the entity sync delivery configuration for Buyers + /// Retrieve the entity sync delivery configuration for buyers Get the entity sync delivery configuration for Buyers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetBuyersAsync(string accessToken = null); - /// Delete the entity sync delivery configuration for Buyers Delete the entity sync delivery configuration for Buyers + /// Delete the entity sync delivery configuration for buyers Delete the entity sync delivery configuration for Buyers /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteBuyersAsync(string accessToken = null); - /// Create or update the entity sync delivery configuration for Buyers Create or update the entity sync delivery configuration for Buyers + /// Create or update the entity sync delivery configuration for buyers Create or update the entity sync delivery configuration for Buyers /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveBuyersAsync(EntitySyncConfig entitySyncConfig, string accessToken = null); - /// Partially update the entity sync delivery configuration for Buyers Partially update the entity sync delivery configuration for Buyers + /// Partially update the entity sync delivery configuration for buyers Partially update the entity sync delivery configuration for Buyers /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchBuyersAsync(PartialEntitySyncConfig partialEntitySyncConfig, string accessToken = null); - /// Sync a buyer. + /// Sync a buyer /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SyncBuyerAsync(SyncBuyer syncBuyer, string accessToken = null); - /// Get the entity sync delivery configuration for BuyerUserGroups Get the entity sync delivery configuration for BuyerUserGroups + /// Retrieve the entity sync delivery configuration for buyer user groups Get the entity sync delivery configuration for BuyerUserGroups /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetBuyerUserGroupsAsync(string accessToken = null); - /// Delete the entity sync delivery configuration for BuyerUserGroups Delete the entity sync delivery configuration for BuyerUserGroups + /// Delete the entity sync delivery configuration for buyer user groups Delete the entity sync delivery configuration for BuyerUserGroups /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteUserGroupsAsync(string accessToken = null); - /// Create or update the entity sync delivery configuration for BuyerUserGroups Create or update the entity sync delivery configuration for BuyerUserGroups + /// Create or update the entity sync delivery configuration for buyer user groups Create or update the entity sync delivery configuration for BuyerUserGroups /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveUserGroupsAsync(EntitySyncConfig entitySyncConfig, string accessToken = null); - /// Partially update the entity sync delivery configuration for BuyerUserGroups Partially update the entity sync delivery configuration for BuyerUserGroups + /// Partially update the entity sync delivery configuration for buyer user groups Partially update the entity sync delivery configuration for BuyerUserGroups /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchBuyerUserGroupsAsync(PartialEntitySyncConfig partialEntitySyncConfig, string accessToken = null); - /// Sync a buyer user group. + /// Sync a buyer user group /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SyncBuyerUserGroupAsync(SyncBuyerUserGroup syncBuyerUserGroup, string accessToken = null); - /// Get the entity sync delivery configuration for InventoryRecords Get the entity sync delivery configuration for InventoryRecords + /// Retrieve the entity sync delivery configuration for inventory records Get the entity sync delivery configuration for InventoryRecords /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetInventoryRecordsAsync(string accessToken = null); - /// Delete the entity sync delivery configuration for InventoryRecords Delete the entity sync delivery configuration for InventoryRecords + /// Delete the entity sync delivery configuration for inventory records Delete the entity sync delivery configuration for InventoryRecords /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteInventoryRecordsAsync(string accessToken = null); - /// Create or update the entity sync delivery configuration for InventoryRecords Create or update the entity sync delivery configuration for InventoryRecords + /// Create or update the entity sync delivery configuration for inventory records Create or update the entity sync delivery configuration for InventoryRecords /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveInventoryRecordsAsync(EntitySyncConfig entitySyncConfig, string accessToken = null); - /// Partially update the entity sync delivery configuration for InventoryRecords Partially update the entity sync delivery configuration for InventoryRecords + /// Partially update the entity sync delivery configuration for inventory records Partially update the entity sync delivery configuration for InventoryRecords /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchInventoryRecordsAsync(PartialEntitySyncConfig partialEntitySyncConfig, string accessToken = null); - /// Sync an inventory record. + /// Sync an inventory record /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SyncInventoryRecordAsync(SyncInventoryRecord syncInventoryRecord, string accessToken = null); @@ -1880,7 +1880,7 @@ public interface IEntitySyncsResource public interface IErrorConfigsResource { - /// Get a single error config. + /// Retrieve an error config. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null); /// Delete an error config. @@ -1894,28 +1894,28 @@ public interface IErrorConfigsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(PartialErrorConfig partialErrorConfig, string accessToken = null); - /// Validates an error config. + /// Validates an error config /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ValidateAsync(string accessToken = null); } public interface IForgottenCredentialsResource { - /// Send a verification code. Sends a temporary verification code via email, which must subsequently be passed in a Reset Password call. The verification code expires in 120 minutes. + /// Send a verification code Sends a temporary verification code via email, which must subsequently be passed in a Reset Password call. The verification code expires in 120 minutes. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SendVerificationCodeAsync(PasswordResetRequest passwordResetRequest, string accessToken = null); - /// Reset a password by verification code. + /// Reset a password by verification code /// Verification code of the password reset. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ResetPasswordByVerificationCodeAsync(string verificationCode, PasswordReset passwordReset, string accessToken = null); - /// Retrieve a username. Sends an email with username for every username associated with an email. Always returns a 200 success regardless of if email doesn’t exist in the clientID. + /// Retrieve a username Sends an email with username for every username associated with an email. Always returns a 200 success regardless of if email doesn’t exist in the clientID. /// ID of the client. /// Email of the forgotten credentials. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task RetrieveUsernameAsync(string clientID, string email, string accessToken = null); - /// Send an one time password. + /// Send an one time password /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SendOneTimePasswordAsync(OneTimePasswordRequest oneTimePasswordRequest, string accessToken = null); @@ -1924,7 +1924,7 @@ public interface IForgottenCredentialsResource /// Features in beta are subject to change and are not available in production. public interface IGroupOrdersResource { - /// Features in beta are subject to change and are not available in production. Get a single group order token. + /// Features in beta are subject to change and are not available in production. Retrieve a group order token. /// ID of the invitation. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetTokenAsync(string invitationID, string accessToken = null); @@ -1932,24 +1932,24 @@ public interface IGroupOrdersResource public interface IImpersonationConfigsResource { - /// Get a single impersonation config. + /// Retrieve an impersonation config. /// ID of the impersonation config. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string impersonationConfigID, string accessToken = null); - /// Get a list of impersonation configs. + /// List impersonation configs. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of impersonation configs. + /// List impersonation configs. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Create a new impersonation config. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an impersonation config. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(ImpersonationConfig impersonationConfig, string accessToken = null); @@ -1971,24 +1971,24 @@ public interface IImpersonationConfigsResource public interface IIncrementorsResource { - /// Get a single incrementor. + /// Retrieve an incrementor. /// ID of the incrementor. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string incrementorID, string accessToken = null); - /// Get a list of incrementors. + /// List incrementors. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of incrementors. + /// List incrementors. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Create a new incrementor. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an incrementor. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Incrementor incrementor, string accessToken = null); @@ -2010,24 +2010,24 @@ public interface IIncrementorsResource public interface IIntegrationEventsResource { - /// Get a single integration event. + /// Retrieve an integration event. /// ID of the integration event. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string integrationEventID, string accessToken = null); - /// Get a list of integration events. + /// List integration events. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of integration events. + /// List integration events. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Create a new integration event. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an integration event. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(IntegrationEvent integrationEvent, string accessToken = null); @@ -2045,45 +2045,45 @@ public interface IIntegrationEventsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string integrationEventID, PartialIntegrationEvent partialIntegrationEvent, string accessToken = null); - /// Estimate shipping cost. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Estimate shipping cost + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task EstimateShippingAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Estimate shipping cost. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Estimate shipping cost + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task EstimateShippingAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrderWorksheet : OrderWorksheet; - /// Select a ship method. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Select a ship method + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SelectShipmethodsAsync(OrderDirection direction, string orderID, OrderShipMethodSelection orderShipMethodSelection, string accessToken = null); - /// Select a ship method. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Select a ship method + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SelectShipmethodsAsync(OrderDirection direction, string orderID, OrderShipMethodSelection orderShipMethodSelection, string accessToken = null) where TOrderWorksheet : OrderWorksheet; - /// Get a single order worksheet. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Get a single order worksheet + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetWorksheetAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Get a single order worksheet. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Get a single order worksheet + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetWorksheetAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrderWorksheet : OrderWorksheet; - /// Calculate an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Calculate an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CalculateAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Calculate an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Calculate an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CalculateAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrderWorksheet : OrderWorksheet; @@ -2091,7 +2091,7 @@ public interface IIntegrationEventsResource public interface IInventoryIntegrationsResource { - /// Get a single inventory integration. + /// Retrieve an inventory integration. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null); /// Delete an inventory integration. @@ -2109,52 +2109,56 @@ public interface IInventoryIntegrationsResource public interface IInventoryRecordsResource { - /// Get a single inventory record. + /// Retrieve an inventory record. /// ID of the product. /// ID of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string productID, string inventoryRecordID, string accessToken = null); - /// Get a single inventory record. + /// Retrieve an inventory record. /// ID of the product. /// ID of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string productID, string inventoryRecordID, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Get a list of inventory records. + /// List inventory records. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of inventory records. + Task> ListAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null); + /// List inventory records. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Get a list of inventory records. + Task> ListAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord; + /// List inventory records. /// ID of the product. /// A lambda or function for specifying various list options fluently. + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListAsync(string productID, Action> buildListOpts, string accessToken = null); - /// Get a list of inventory records. + Task> ListAsync(string productID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null); + /// List inventory records. /// ID of the product. /// A lambda or function for specifying various list options fluently. + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListAsync(string productID, Action> buildListOpts, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Create a new inventory record. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + Task> ListAsync(string productID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord; + /// Create an inventory record. /// ID of the product. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string productID, InventoryRecord inventoryRecord, string accessToken = null); - /// Create a new inventory record. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an inventory record. /// ID of the product. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -2188,107 +2192,111 @@ public interface IInventoryRecordsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string productID, string inventoryRecordID, PartialInventoryRecord partialInventoryRecord, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Get a list of variant inventory records. + /// Get a list of variant inventory records /// ID of the product. /// ID of the variant. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListVariantAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of variant inventory records. + Task> ListVariantAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null); + /// Get a list of variant inventory records /// ID of the product. /// ID of the variant. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListVariantAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Get a list of variant inventory records. + Task> ListVariantAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord; + /// Get a list of variant inventory records /// ID of the product. /// ID of the variant. /// A lambda or function for specifying various list options fluently. + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListVariantAsync(string productID, string variantID, Action> buildListOpts, string accessToken = null); - /// Get a list of variant inventory records. + Task> ListVariantAsync(string productID, string variantID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null); + /// Get a list of variant inventory records /// ID of the product. /// ID of the variant. /// A lambda or function for specifying various list options fluently. + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListVariantAsync(string productID, string variantID, Action> buildListOpts, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Get a single variant inventory record. + Task> ListVariantAsync(string productID, string variantID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord; + /// Get a single variant inventory record /// ID of the product. /// ID of the variant. /// ID of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetVariantAsync(string productID, string variantID, string inventoryRecordID, string accessToken = null); - /// Get a single variant inventory record. + /// Get a single variant inventory record /// ID of the product. /// ID of the variant. /// ID of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetVariantAsync(string productID, string variantID, string inventoryRecordID, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Create a new variant inventory record. + /// Create a new variant inventory record /// ID of the product. /// ID of the variant. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateVariantAsync(string productID, string variantID, InventoryRecord inventoryRecord, string accessToken = null); - /// Create a new variant inventory record. + /// Create a new variant inventory record /// ID of the product. /// ID of the variant. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateVariantAsync(string productID, string variantID, InventoryRecord inventoryRecord, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Create or update a variant inventory record. + /// Create or update a variant inventory record /// ID of the product. /// ID of the variant. /// ID of the inventory record. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveVariantAsync(string productID, string variantID, string inventoryRecordID, InventoryRecord inventoryRecord, string accessToken = null); - /// Create or update a variant inventory record. + /// Create or update a variant inventory record /// ID of the product. /// ID of the variant. /// ID of the inventory record. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveVariantAsync(string productID, string variantID, string inventoryRecordID, InventoryRecord inventoryRecord, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Partially update a variant inventory record. + /// Partially update a variant inventory record /// ID of the product. /// ID of the variant. /// ID of the inventory record. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchVariantAsync(string productID, string variantID, string inventoryRecordID, PartialInventoryRecord partialInventoryRecord, string accessToken = null); - /// Partially update a variant inventory record. + /// Partially update a variant inventory record /// ID of the product. /// ID of the variant. /// ID of the inventory record. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchVariantAsync(string productID, string variantID, string inventoryRecordID, PartialInventoryRecord partialInventoryRecord, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Delete a variant inventory record. + /// Delete a variant inventory record /// ID of the product. /// ID of the variant. /// ID of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteVariantAsync(string productID, string variantID, string inventoryRecordID, string accessToken = null); - /// Get a list of inventory record assignments. + /// List inventory record assignments. /// ID of the product. /// ID of the buyer. /// ID of the inventory record. /// ID of the user. /// ID of the user group. /// Level of the inventory record assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string productID, string buyerID = null, string inventoryRecordID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Create or update an inventory record assignment. @@ -2304,7 +2312,7 @@ public interface IInventoryRecordsResource /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAssignmentAsync(string productID, string inventoryRecordID, string buyerID, string userID = null, string userGroupID = null, string accessToken = null); - /// Get a list of inventory record variant assignments. + /// List inventory record variant assignments. /// ID of the product. /// ID of the variant. /// ID of the buyer. @@ -2312,8 +2320,8 @@ public interface IInventoryRecordsResource /// ID of the user. /// ID of the user group. /// Level of the inventory record assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListVariantAssignmentsAsync(string productID, string variantID, string buyerID = null, string inventoryRecordID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Create or update an inventory record variant assignment. @@ -2335,158 +2343,158 @@ public interface IInventoryRecordsResource public interface ILineItemsResource { - /// Get a single line item. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Retrieve a line item. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(OrderDirection direction, string orderID, string lineItemID, string accessToken = null); - /// Get a single line item. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Retrieve a line item. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(OrderDirection direction, string orderID, string lineItemID, string accessToken = null) where TLineItem : LineItem; - /// Get a list of line items. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List line items. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of line items. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List line items. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TLineItem : LineItem; - /// Get a list of line items. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List line items. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null); - /// Get a list of line items. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List line items. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null) where TLineItem : LineItem; - /// Create a new line item. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a line item. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderDirection direction, string orderID, LineItem lineItem, string accessToken = null); - /// Create a new line item. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a line item. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderDirection direction, string orderID, LineItem lineItem, string accessToken = null) where TLineItem : LineItem; /// Create or update a line item. If an object with the same ID already exists, it will be overwritten. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAsync(OrderDirection direction, string orderID, string lineItemID, LineItem lineItem, string accessToken = null); /// Create or update a line item. If an object with the same ID already exists, it will be overwritten. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAsync(OrderDirection direction, string orderID, string lineItemID, LineItem lineItem, string accessToken = null) where TLineItem : LineItem; /// Delete a line item. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAsync(OrderDirection direction, string orderID, string lineItemID, string accessToken = null); /// Partially update a line item. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(OrderDirection direction, string orderID, string lineItemID, PartialLineItem partialLineItem, string accessToken = null); /// Partially update a line item. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(OrderDirection direction, string orderID, string lineItemID, PartialLineItem partialLineItem, string accessToken = null) where TLineItem : LineItem; - /// Set a shipping address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Set a shipping address + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShippingAddressAsync(OrderDirection direction, string orderID, string lineItemID, Address address, string accessToken = null); - /// Set a shipping address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Set a shipping address + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShippingAddressAsync(OrderDirection direction, string orderID, string lineItemID, Address address, string accessToken = null) where TLineItem : LineItem; /// Partially update a line item shipping address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchShippingAddressAsync(OrderDirection direction, string orderID, string lineItemID, PartialAddress partialAddress, string accessToken = null); /// Partially update a line item shipping address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the line item. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchShippingAddressAsync(OrderDirection direction, string orderID, string lineItemID, PartialAddress partialAddress, string accessToken = null) where TLineItem : LineItem; - /// Get a list of line item across orders. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List line item across orders. + /// Direction of the order, from the current user's perspective. /// ID of the buyer. /// ID of the supplier. /// Lower bound of date range that the order was created. /// Upper bound of date range that the order was created. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAcrossOrdersAsync(OrderDirection direction, string buyerID = null, string supplierID = null, DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of line item across orders. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List line item across orders. + /// Direction of the order, from the current user's perspective. /// ID of the buyer. /// ID of the supplier. /// Lower bound of date range that the order was created. /// Upper bound of date range that the order was created. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAcrossOrdersAsync(OrderDirection direction, string buyerID = null, string supplierID = null, DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TExtendedLineItem : ExtendedLineItem; - /// Get a list of line item across orders. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List line item across orders. + /// Direction of the order, from the current user's perspective. /// A lambda or function for specifying various list options fluently. /// ID of the buyer. /// ID of the supplier. @@ -2494,8 +2502,8 @@ public interface ILineItemsResource /// Upper bound of date range that the order was created. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAcrossOrdersAsync(OrderDirection direction, Action> buildListOpts, string buyerID = null, string supplierID = null, DateTimeOffset? from = null, DateTimeOffset? to = null, string accessToken = null); - /// Get a list of line item across orders. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List line item across orders. + /// Direction of the order, from the current user's perspective. /// A lambda or function for specifying various list options fluently. /// ID of the buyer. /// ID of the supplier. @@ -2507,24 +2515,24 @@ public interface ILineItemsResource public interface ILocalesResource { - /// Get a single locale. + /// Retrieve a locale. /// ID of the locale. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string localeID, string accessToken = null); - /// Get a list of locales. + /// List locales. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of locales. + /// List locales. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Create a new locale. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a locale. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Locale locale, string accessToken = null); @@ -2542,14 +2550,14 @@ public interface ILocalesResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string localeID, PartialLocale partialLocale, string accessToken = null); - /// Get a list of locale assignments. + /// List locale assignments. /// ID of the buyer. /// ID of the locale. /// ID of the user. /// ID of the user group. /// Level of the locale assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string buyerID = null, string localeID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Create or update a locale assignment. Do not assign a user multiple groups with different assigned locales. That is considered a misconfiguration, and will yield unexpected results. @@ -2567,128 +2575,128 @@ public interface ILocalesResource public interface IMeResource { - /// Get the Current Authenticated User + /// Get the currently authenticated user /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null); - /// Get the Current Authenticated User + /// Get the currently authenticated user /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null) where TMeUser : MeUser; - /// Update the Currently Authenticated User If an object with the same ID already exists, it will be overwritten. + /// Update the currently authenticated user If an object with the same ID already exists, it will be overwritten. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAsync(MeUser meUser, string accessToken = null); - /// Update the Currently Authenticated User If an object with the same ID already exists, it will be overwritten. + /// Update the currently authenticated user If an object with the same ID already exists, it will be overwritten. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAsync(MeUser meUser, string accessToken = null) where TMeUser : MeUser; - /// Patch the Currently Authenticated User. + /// Patch the currently authenticated user /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(PartialMeUser partialMeUser, string accessToken = null); - /// Patch the Currently Authenticated User. + /// Patch the currently authenticated user /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(PartialMeUser partialMeUser, string accessToken = null) where TMeUser : MeUser; - /// Get a list of cost centers visible to this user. Only available to Buyer Users. + /// List cost centers visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCostCentersAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of cost centers visible to this user. Only available to Buyer Users. + /// List cost centers visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCostCentersAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TCostCenter : CostCenter; - /// Get a list of cost centers visible to this user. Only available to Buyer Users. + /// List cost centers visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCostCentersAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of cost centers visible to this user. Only available to Buyer Users. + /// List cost centers visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCostCentersAsync(Action> buildListOpts, string accessToken = null) where TCostCenter : CostCenter; - /// Get a list of user groups visible to this user. Only available to Buyer Users. + /// List user groups visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListUserGroupsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of user groups visible to this user. Only available to Buyer Users. + /// List user groups visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListUserGroupsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of user groups visible to this user. Only available to Buyer Users. + /// List user groups visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListUserGroupsAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of user groups visible to this user. Only available to Buyer Users. + /// List user groups visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListUserGroupsAsync(Action> buildListOpts, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of addresses visible to this user. Only available to Buyer Users. + /// List addresses visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAddressesAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of addresses visible to this user. Only available to Buyer Users. + /// List addresses visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAddressesAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TBuyerAddress : BuyerAddress; - /// Get a list of addresses visible to this user. Only available to Buyer Users. + /// List addresses visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAddressesAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of addresses visible to this user. Only available to Buyer Users. + /// List addresses visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAddressesAsync(Action> buildListOpts, string accessToken = null) where TBuyerAddress : BuyerAddress; - /// Create a new address. Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them. + /// Create an address. Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAddressAsync(BuyerAddress buyerAddress, string accessToken = null); - /// Create a new address. Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them. + /// Create an address. Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAddressAsync(BuyerAddress buyerAddress, string accessToken = null) where TBuyerAddress : BuyerAddress; - /// Get a single address. Only available to Buyer Users. + /// Retrieve an address. Only available to Buyer Users. /// ID of the address. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAddressAsync(string addressID, string accessToken = null); - /// Get a single address. Only available to Buyer Users. + /// Retrieve an address. Only available to Buyer Users. /// ID of the address. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAddressAsync(string addressID, string accessToken = null) where TBuyerAddress : BuyerAddress; - /// Update an address. Only available to Buyer Users. + /// Update an address Only available to Buyer Users. /// ID of the address. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAddressAsync(string addressID, BuyerAddress buyerAddress, string accessToken = null); - /// Update an address. Only available to Buyer Users. + /// Update an address Only available to Buyer Users. /// ID of the address. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -2702,54 +2710,54 @@ public interface IMeResource /// ID of the address. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAddressAsync(string addressID, string accessToken = null); - /// Create a new credit card. Only available to Buyer Users. Credit Cards created using this endpoint are considered private, and only accessible to the user who created them. + /// Create a credit card. Only available to Buyer Users. Credit Cards created using this endpoint are considered private, and only accessible to the user who created them. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateCreditCardAsync(BuyerCreditCard buyerCreditCard, string accessToken = null); - /// Create a new credit card. Only available to Buyer Users. Credit Cards created using this endpoint are considered private, and only accessible to the user who created them. + /// Create a credit card. Only available to Buyer Users. Credit Cards created using this endpoint are considered private, and only accessible to the user who created them. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateCreditCardAsync(BuyerCreditCard buyerCreditCard, string accessToken = null) where TBuyerCreditCard : BuyerCreditCard; - /// Get a list of credit cards visible to this user. Only available to Buyer Users. + /// List credit cards visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCreditCardsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of credit cards visible to this user. Only available to Buyer Users. + /// List credit cards visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCreditCardsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TBuyerCreditCard : BuyerCreditCard; - /// Get a list of credit cards visible to this user. Only available to Buyer Users. + /// List credit cards visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCreditCardsAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of credit cards visible to this user. Only available to Buyer Users. + /// List credit cards visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCreditCardsAsync(Action> buildListOpts, string accessToken = null) where TBuyerCreditCard : BuyerCreditCard; - /// Get a single credit card. Only available to Buyer Users. + /// Retrieve a credit card. Only available to Buyer Users. /// ID of the creditcard. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetCreditCardAsync(string creditcardID, string accessToken = null); - /// Get a single credit card. Only available to Buyer Users. + /// Retrieve a credit card. Only available to Buyer Users. /// ID of the creditcard. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetCreditCardAsync(string creditcardID, string accessToken = null) where TBuyerCreditCard : BuyerCreditCard; - /// Update a credit card. Only available to Buyer Users. + /// Update a credit card Only available to Buyer Users. /// ID of the creditcard. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveCreditCardAsync(string creditcardID, BuyerCreditCard buyerCreditCard, string accessToken = null); - /// Update a credit card. Only available to Buyer Users. + /// Update a credit card Only available to Buyer Users. /// ID of the creditcard. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -2763,83 +2771,83 @@ public interface IMeResource /// ID of the creditcard. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteCreditCardAsync(string creditcardID, string accessToken = null); - /// Get a list of categories visible to this user. Only available to Buyer Users. + /// List categories visible to this user. Only available to Buyer Users. /// Indicates how deep down the hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to ParentID if specified. Default is 1. /// The user’s default CatalogID will be used to return categories if you do not pass another CatalogID explicitly. Listing categories across multiple catalogs is not supported. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCategoriesAsync(string depth = "1", string catalogID = null, string productID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of categories visible to this user. Only available to Buyer Users. + /// List categories visible to this user. Only available to Buyer Users. /// Indicates how deep down the hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to ParentID if specified. Default is 1. /// The user’s default CatalogID will be used to return categories if you do not pass another CatalogID explicitly. Listing categories across multiple catalogs is not supported. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCategoriesAsync(string depth = "1", string catalogID = null, string productID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TCategory : Category; - /// Get a list of categories visible to this user. Only available to Buyer Users. + /// List categories visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Indicates how deep down the hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to ParentID if specified. Default is 1. /// The user’s default CatalogID will be used to return categories if you do not pass another CatalogID explicitly. Listing categories across multiple catalogs is not supported. /// ID of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCategoriesAsync(Action> buildListOpts, string depth = "1", string catalogID = null, string productID = null, string accessToken = null); - /// Get a list of categories visible to this user. Only available to Buyer Users. + /// List categories visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Indicates how deep down the hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to ParentID if specified. Default is 1. /// The user’s default CatalogID will be used to return categories if you do not pass another CatalogID explicitly. Listing categories across multiple catalogs is not supported. /// ID of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCategoriesAsync(Action> buildListOpts, string depth = "1", string catalogID = null, string productID = null, string accessToken = null) where TCategory : Category; - /// Get a single category. Only available to Buyer Users. + /// Retrieve a category. Only available to Buyer Users. /// ID of the category. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetCategoryAsync(string categoryID, string catalogID, string accessToken = null); - /// Get a single category. Only available to Buyer Users. + /// Retrieve a category. Only available to Buyer Users. /// ID of the category. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetCategoryAsync(string categoryID, string catalogID, string accessToken = null) where TCategory : Category; - /// Get a list of products visible to this user. Only available to Buyer Users. + /// List products visible to this user. Only available to Buyer Users. /// ID of the catalog. /// ID of the category. /// Indicates how deep down the category hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to CategoryID if specified, otherwise top level of the Catalog. Default is 'all'. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductsAsync(string catalogID = null, string categoryID = null, string depth = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string sellerID = null, string accessToken = null); - /// Get a list of products visible to this user. Only available to Buyer Users. + /// List products visible to this user. Only available to Buyer Users. /// ID of the catalog. /// ID of the category. /// Indicates how deep down the category hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to CategoryID if specified, otherwise top level of the Catalog. Default is 'all'. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductsAsync(string catalogID = null, string categoryID = null, string depth = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string sellerID = null, string accessToken = null) where TBuyerProduct : BuyerProduct; - /// Get a list of products visible to this user. Only available to Buyer Users. + /// List products visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// ID of the catalog. /// ID of the category. @@ -2847,7 +2855,7 @@ public interface IMeResource /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductsAsync(Action> buildListOpts, string catalogID = null, string categoryID = null, string depth = null, string sellerID = null, string accessToken = null); - /// Get a list of products visible to this user. Only available to Buyer Users. + /// List products visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// ID of the catalog. /// ID of the category. @@ -2855,479 +2863,487 @@ public interface IMeResource /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductsAsync(Action> buildListOpts, string catalogID = null, string categoryID = null, string depth = null, string sellerID = null, string accessToken = null) where TBuyerProduct : BuyerProduct; - /// Get a single product. Only available to Buyer Users. + /// Retrieve a product. Only available to Buyer Users. /// ID of the product. /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetProductAsync(string productID, string sellerID = null, string accessToken = null); - /// Get a single product. Only available to Buyer Users. + /// Retrieve a product. Only available to Buyer Users. /// ID of the product. /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetProductAsync(string productID, string sellerID = null, string accessToken = null) where TBuyerProduct : BuyerProduct; - /// Get a list of specs visible to this user. Only available to Buyer Users. + /// List specs visible to this user. Only available to Buyer Users. /// ID of the product. /// ID of the catalog. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpecsAsync(string productID, string catalogID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of specs visible to this user. Only available to Buyer Users. + /// List specs visible to this user. Only available to Buyer Users. /// ID of the product. /// ID of the catalog. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpecsAsync(string productID, string catalogID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSpec : Spec; - /// Get a list of specs visible to this user. Only available to Buyer Users. + /// List specs visible to this user. Only available to Buyer Users. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpecsAsync(string productID, Action> buildListOpts, string catalogID = null, string accessToken = null); - /// Get a list of specs visible to this user. Only available to Buyer Users. + /// List specs visible to this user. Only available to Buyer Users. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpecsAsync(string productID, Action> buildListOpts, string catalogID = null, string accessToken = null) where TSpec : Spec; - /// Get a single spec. Only available to Buyer Users. + /// Retrieve a spec. Only available to Buyer Users. /// ID of the product. /// ID of the spec. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSpecAsync(string productID, string specID, string catalogID = null, string accessToken = null); - /// Get a single spec. Only available to Buyer Users. + /// Retrieve a spec. Only available to Buyer Users. /// ID of the product. /// ID of the spec. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSpecAsync(string productID, string specID, string catalogID = null, string accessToken = null) where TSpec : Spec; - /// Get a list of variants visible to this user. Only available to Buyer Users. + /// List variants visible to this user. Only available to Buyer Users. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListVariantsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of variants visible to this user. Only available to Buyer Users. + /// List variants visible to this user. Only available to Buyer Users. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListVariantsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TVariant : Variant; - /// Get a list of variants visible to this user. Only available to Buyer Users. + /// List variants visible to this user. Only available to Buyer Users. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListVariantsAsync(string productID, Action> buildListOpts, string accessToken = null); - /// Get a list of variants visible to this user. Only available to Buyer Users. + /// List variants visible to this user. Only available to Buyer Users. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListVariantsAsync(string productID, Action> buildListOpts, string accessToken = null) where TVariant : Variant; - /// Get a single variant. Only available to Buyer Users. + /// Retrieve a variant. Only available to Buyer Users. /// ID of the product. /// ID of the variant. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetVariantAsync(string productID, string variantID, string accessToken = null); - /// Get a single variant. Only available to Buyer Users. + /// Retrieve a variant. Only available to Buyer Users. /// ID of the product. /// ID of the variant. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetVariantAsync(string productID, string variantID, string accessToken = null) where TVariant : Variant; - /// Get a list of product inventory records visible to this user. Only available to Buyer Users. + /// List product inventory records visible to this user. Only available to Buyer Users. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListProductInventoryRecordsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product inventory records visible to this user. Only available to Buyer Users. + Task> ListProductInventoryRecordsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null); + /// List product inventory records visible to this user. Only available to Buyer Users. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListProductInventoryRecordsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Get a list of product inventory records visible to this user. Only available to Buyer Users. + Task> ListProductInventoryRecordsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord; + /// List product inventory records visible to this user. Only available to Buyer Users. /// ID of the product. /// A lambda or function for specifying various list options fluently. + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListProductInventoryRecordsAsync(string productID, Action> buildListOpts, string accessToken = null); - /// Get a list of product inventory records visible to this user. Only available to Buyer Users. + Task> ListProductInventoryRecordsAsync(string productID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null); + /// List product inventory records visible to this user. Only available to Buyer Users. /// ID of the product. /// A lambda or function for specifying various list options fluently. + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListProductInventoryRecordsAsync(string productID, Action> buildListOpts, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Get a list of variant inventory records visible to this user. Only available to Buyer Users. + Task> ListProductInventoryRecordsAsync(string productID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord; + /// List variant inventory records visible to this user. Only available to Buyer Users. /// ID of the product. /// ID of the variant. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListVariantInventoryRecordsAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of variant inventory records visible to this user. Only available to Buyer Users. + Task> ListVariantInventoryRecordsAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null); + /// List variant inventory records visible to this user. Only available to Buyer Users. /// ID of the product. /// ID of the variant. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListVariantInventoryRecordsAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Get a list of variant inventory records visible to this user. Only available to Buyer Users. + Task> ListVariantInventoryRecordsAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord; + /// List variant inventory records visible to this user. Only available to Buyer Users. /// ID of the product. /// ID of the variant. /// A lambda or function for specifying various list options fluently. + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListVariantInventoryRecordsAsync(string productID, string variantID, Action> buildListOpts, string accessToken = null); - /// Get a list of variant inventory records visible to this user. Only available to Buyer Users. + Task> ListVariantInventoryRecordsAsync(string productID, string variantID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null); + /// List variant inventory records visible to this user. Only available to Buyer Users. /// ID of the product. /// ID of the variant. /// A lambda or function for specifying various list options fluently. + /// Include address of the inventory record. /// Optional. Use to provide an existing token instead of authenticating implicitly. - Task> ListVariantInventoryRecordsAsync(string productID, string variantID, Action> buildListOpts, string accessToken = null) where TInventoryRecord : InventoryRecord; - /// Get a list of orders visible to this user. List orders created by this user. + Task> ListVariantInventoryRecordsAsync(string productID, string variantID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord; + /// List orders visible to this user. List orders created by this user. /// Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListOrdersAsync(DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of orders visible to this user. List orders created by this user. + /// List orders visible to this user. List orders created by this user. /// Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListOrdersAsync(DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TOrder : Order; - /// Get a list of orders visible to this user. List orders created by this user. + /// List orders visible to this user. List orders created by this user. /// A lambda or function for specifying various list options fluently. /// Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListOrdersAsync(Action> buildListOpts, DateTimeOffset? from = null, DateTimeOffset? to = null, string accessToken = null); - /// Get a list of orders visible to this user. List orders created by this user. + /// List orders visible to this user. List orders created by this user. /// A lambda or function for specifying various list options fluently. /// Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListOrdersAsync(Action> buildListOpts, DateTimeOffset? from = null, DateTimeOffset? to = null, string accessToken = null) where TOrder : Order; - /// Get a list of orders that this user can approve. + /// Get a list of orders that this user can approve /// Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovableOrdersAsync(DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of orders that this user can approve. + /// Get a list of orders that this user can approve /// Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovableOrdersAsync(DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TOrder : Order; - /// Get a list of orders that this user can approve. + /// Get a list of orders that this user can approve /// A lambda or function for specifying various list options fluently. /// Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovableOrdersAsync(Action> buildListOpts, DateTimeOffset? from = null, DateTimeOffset? to = null, string accessToken = null); - /// Get a list of orders that this user can approve. + /// Get a list of orders that this user can approve /// A lambda or function for specifying various list options fluently. /// Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovableOrdersAsync(Action> buildListOpts, DateTimeOffset? from = null, DateTimeOffset? to = null, string accessToken = null) where TOrder : Order; - /// Transfer an order. If a user begins an order as the anonymous shopper and later logs in, use this endpoint to transfer that order to them. + /// Transfer an anon user order If a user begins an order as the anonymous shopper and later logs in, use this endpoint to transfer that order to them. /// Anon user token of the me. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task TransferAnonUserOrderAsync(string anonUserToken, string accessToken = null); - /// Reset a password by token. + /// Reset a password by token /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ResetPasswordByTokenAsync(TokenPasswordReset tokenPasswordReset, string accessToken = null); - /// Get a list of promotions visible to this user. Only available to Buyer Users. + /// List promotions visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of promotions visible to this user. Only available to Buyer Users. + /// List promotions visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TPromotion : Promotion; - /// Get a list of promotions visible to this user. Only available to Buyer Users. + /// List promotions visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of promotions visible to this user. Only available to Buyer Users. + /// List promotions visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(Action> buildListOpts, string accessToken = null) where TPromotion : Promotion; - /// Get a single promotion. Only available to Buyer Users. + /// Retrieve a promotion. Only available to Buyer Users. /// ID of the promotion. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetPromotionAsync(string promotionID, string accessToken = null); - /// Get a single promotion. Only available to Buyer Users. + /// Retrieve a promotion. Only available to Buyer Users. /// ID of the promotion. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetPromotionAsync(string promotionID, string accessToken = null) where TPromotion : Promotion; - /// Get a list of spending accounts visible to this user. Only available to Buyer Users. + /// List spending accounts visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpendingAccountsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of spending accounts visible to this user. Only available to Buyer Users. + /// List spending accounts visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpendingAccountsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSpendingAccount : SpendingAccount; - /// Get a list of spending accounts visible to this user. Only available to Buyer Users. + /// List spending accounts visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpendingAccountsAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of spending accounts visible to this user. Only available to Buyer Users. + /// List spending accounts visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpendingAccountsAsync(Action> buildListOpts, string accessToken = null) where TSpendingAccount : SpendingAccount; - /// Get a single spending account. Only available to Buyer Users. + /// Retrieve a spending account. Only available to Buyer Users. /// ID of the spending account. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSpendingAccountAsync(string spendingAccountID, string accessToken = null); - /// Get a single spending account. Only available to Buyer Users. + /// Retrieve a spending account. Only available to Buyer Users. /// ID of the spending account. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSpendingAccountAsync(string spendingAccountID, string accessToken = null) where TSpendingAccount : SpendingAccount; - /// Get a list of shipments visible to this user. Only available to Buyer Users. + /// List shipments visible to this user. Only available to Buyer Users. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentsAsync(string orderID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of shipments visible to this user. Only available to Buyer Users. + /// List shipments visible to this user. Only available to Buyer Users. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentsAsync(string orderID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TShipment : Shipment; - /// Get a list of shipments visible to this user. Only available to Buyer Users. + /// List shipments visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentsAsync(Action> buildListOpts, string orderID = null, string accessToken = null); - /// Get a list of shipments visible to this user. Only available to Buyer Users. + /// List shipments visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentsAsync(Action> buildListOpts, string orderID = null, string accessToken = null) where TShipment : Shipment; - /// Get a single shipment. Only available to Buyer Users. + /// Retrieve a shipment. Only available to Buyer Users. /// ID of the shipment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetShipmentAsync(string shipmentID, string accessToken = null); - /// Get a single shipment. Only available to Buyer Users. + /// Retrieve a shipment. Only available to Buyer Users. /// ID of the shipment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetShipmentAsync(string shipmentID, string accessToken = null) where TShipment : Shipment; - /// Get a list of shipment items visible to this user. Only available to Buyer Users. + /// List shipment items visible to this user. Only available to Buyer Users. /// ID of the shipment. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentItemsAsync(string shipmentID, string orderID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of shipment items visible to this user. Only available to Buyer Users. + /// List shipment items visible to this user. Only available to Buyer Users. /// ID of the shipment. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentItemsAsync(string shipmentID, string orderID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TShipmentItem : ShipmentItem; - /// Get a list of shipment items visible to this user. Only available to Buyer Users. + /// List shipment items visible to this user. Only available to Buyer Users. /// ID of the shipment. /// A lambda or function for specifying various list options fluently. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentItemsAsync(string shipmentID, Action> buildListOpts, string orderID = null, string accessToken = null); - /// Get a list of shipment items visible to this user. Only available to Buyer Users. + /// List shipment items visible to this user. Only available to Buyer Users. /// ID of the shipment. /// A lambda or function for specifying various list options fluently. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentItemsAsync(string shipmentID, Action> buildListOpts, string orderID = null, string accessToken = null) where TShipmentItem : ShipmentItem; - /// Register a User. + /// Register a user /// The object that will be serialized to JSON and sent in the request body. /// Anon user token of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task RegisterAsync(MeUser meUser, string anonUserToken, string accessToken = null); - /// Get a list of catalogs visible to this user. Only available to Buyer Users. + /// List catalogs visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCatalogsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string sellerID = null, string accessToken = null); - /// Get a list of catalogs visible to this user. Only available to Buyer Users. + /// List catalogs visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCatalogsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string sellerID = null, string accessToken = null) where TCatalog : Catalog; - /// Get a list of catalogs visible to this user. Only available to Buyer Users. + /// List catalogs visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCatalogsAsync(Action> buildListOpts, string sellerID = null, string accessToken = null); - /// Get a list of catalogs visible to this user. Only available to Buyer Users. + /// List catalogs visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// ID of the seller. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCatalogsAsync(Action> buildListOpts, string sellerID = null, string accessToken = null) where TCatalog : Catalog; - /// Get a single catalog. Only available to Buyer Users. + /// Retrieve a catalog. Only available to Buyer Users. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetCatalogAsync(string catalogID, string accessToken = null); - /// Get a single catalog. Only available to Buyer Users. + /// Retrieve a catalog. Only available to Buyer Users. /// ID of the catalog. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetCatalogAsync(string catalogID, string accessToken = null) where TCatalog : Catalog; - /// Get a list of sellers this user can purchase from. Organizations you can place orders directly to. + /// Get a list of sellers this user can purchase from Organizations you can place orders directly to. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListBuyerSellersAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of sellers this user can purchase from. Organizations you can place orders directly to. + /// Get a list of sellers this user can purchase from Organizations you can place orders directly to. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListBuyerSellersAsync(Action> buildListOpts, string accessToken = null); - /// Create a new product collection. Only available to Buyer Users. + /// Create a product collection. Only available to Buyer Users. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateProductCollectionAsync(ProductCollection productCollection, string accessToken = null); - /// Create a new product collection. Only available to Buyer Users. + /// Create a product collection. Only available to Buyer Users. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateProductCollectionAsync(ProductCollection productCollection, string accessToken = null) where TProductCollection : ProductCollection; - /// Get a single product collection. Only available to Buyer Users. + /// Retrieve a product collection. Only available to Buyer Users. /// ID of the product collection. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetProductCollectionAsync(string productCollectionID, string accessToken = null); - /// Get a single product collection. Only available to Buyer Users. + /// Retrieve a product collection. Only available to Buyer Users. /// ID of the product collection. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetProductCollectionAsync(string productCollectionID, string accessToken = null) where TProductCollection : ProductCollection; - /// Get a list of product collections visible to this user. Only available to Buyer Users. + /// List product collections visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product collections visible to this user. Only available to Buyer Users. + /// List product collections visible to this user. Only available to Buyer Users. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TProductCollection : ProductCollection; - /// Get a list of product collections visible to this user. Only available to Buyer Users. + /// List product collections visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionsAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of product collections visible to this user. Only available to Buyer Users. + /// List product collections visible to this user. Only available to Buyer Users. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionsAsync(Action> buildListOpts, string accessToken = null) where TProductCollection : ProductCollection; @@ -3355,39 +3371,39 @@ public interface IMeResource /// ID of the product collection. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteProductCollectionAsync(string productCollectionID, string accessToken = null); - /// Get a list of product collection entries visible to this user. Only available to Buyer Users. + /// List product collection entries visible to this user. Only available to Buyer Users. /// ID of the product collection. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionEntriesAsync(string productCollectionID, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product collection entries visible to this user. Only available to Buyer Users. + /// List product collection entries visible to this user. Only available to Buyer Users. /// ID of the product collection. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionEntriesAsync(string productCollectionID, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TProductCollectionBuyerProduct : ProductCollectionBuyerProduct; - /// Get a list of product collection entries visible to this user. Only available to Buyer Users. + /// List product collection entries visible to this user. Only available to Buyer Users. /// ID of the product collection. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionEntriesAsync(string productCollectionID, Action> buildListOpts, string accessToken = null); - /// Get a list of product collection entries visible to this user. Only available to Buyer Users. + /// List product collection entries visible to this user. Only available to Buyer Users. /// ID of the product collection. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionEntriesAsync(string productCollectionID, Action> buildListOpts, string accessToken = null) where TProductCollectionBuyerProduct : ProductCollectionBuyerProduct; - /// Create a new product collection entry. Only available to Buyer Users. + /// Create a product collection entry. Only available to Buyer Users. /// ID of the product collection. /// ID of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -3402,12 +3418,12 @@ public interface IMeResource /// ID of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteProductCollectionEntryAsync(string productCollectionID, string productID, string accessToken = null); - /// Create a new product collection invitation. Only available to Buyer Users. + /// Create a product collection invitation. Only available to Buyer Users. /// ID of the product collection. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateProductCollectionInvitationAsync(string productCollectionID, ProductCollectionInvitation productCollectionInvitation, string accessToken = null); - /// Create a new product collection invitation. Only available to Buyer Users. + /// Create a product collection invitation. Only available to Buyer Users. /// ID of the product collection. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -3429,97 +3445,97 @@ public interface IMeResource /// ID of the invitation. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteProductCollectionInvitationAsync(string productCollectionID, string invitationID, string accessToken = null); - /// Get a single product collection invitation. Only available to Buyer Users. + /// Retrieve a product collection invitation. Only available to Buyer Users. /// ID of the product collection. /// ID of the invitation. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetProductCollectionInvitationAsync(string productCollectionID, string invitationID, string accessToken = null); - /// Get a single product collection invitation. Only available to Buyer Users. + /// Retrieve a product collection invitation. Only available to Buyer Users. /// ID of the product collection. /// ID of the invitation. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetProductCollectionInvitationAsync(string productCollectionID, string invitationID, string accessToken = null) where TProductCollectionInvitation : ProductCollectionInvitation; - /// Get a list of product collection invitations visible to this user. Only available to Buyer Users. + /// List product collection invitations visible to this user. Only available to Buyer Users. /// ID of the product collection. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionInvitationsAsync(string productCollectionID, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product collection invitations visible to this user. Only available to Buyer Users. + /// List product collection invitations visible to this user. Only available to Buyer Users. /// ID of the product collection. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionInvitationsAsync(string productCollectionID, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TProductCollectionInvitation : ProductCollectionInvitation; - /// Get a list of product collection invitations visible to this user. Only available to Buyer Users. + /// List product collection invitations visible to this user. Only available to Buyer Users. /// ID of the product collection. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionInvitationsAsync(string productCollectionID, Action> buildListOpts, string accessToken = null); - /// Get a list of product collection invitations visible to this user. Only available to Buyer Users. + /// List product collection invitations visible to this user. Only available to Buyer Users. /// ID of the product collection. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductCollectionInvitationsAsync(string productCollectionID, Action> buildListOpts, string accessToken = null) where TProductCollectionInvitation : ProductCollectionInvitation; - /// Accept a product collection invitation. + /// Accept a product collection invitation /// ID of the product collection. /// ID of the invitation. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task AcceptProductCollectionInvitationAsync(string productCollectionID, string invitationID, string accessToken = null); - /// Decline a product collection invitation. + /// Decline a product collection invitation /// ID of the product collection. /// ID of the invitation. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeclineProductCollectionInvitationAsync(string productCollectionID, string invitationID, string accessToken = null); - /// Get a list of subscriptions visible to this user. + /// List subscriptions visible to this user. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSubscriptionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of subscriptions visible to this user. + /// List subscriptions visible to this user. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSubscriptionsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSubscription : Subscription; - /// Get a list of subscriptions visible to this user. + /// List subscriptions visible to this user. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSubscriptionsAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of subscriptions visible to this user. + /// List subscriptions visible to this user. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSubscriptionsAsync(Action> buildListOpts, string accessToken = null) where TSubscription : Subscription; - /// Get a single subscription. + /// Retrieve a subscription. /// ID of the subscription. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSubscriptionAsync(string subscriptionID, string accessToken = null); - /// Get a single subscription. + /// Retrieve a subscription. /// ID of the subscription. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSubscriptionAsync(string subscriptionID, string accessToken = null) where TSubscription : Subscription; - /// Create a new subscription. + /// Create a subscription. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateSubscriptionAsync(Subscription subscription, string accessToken = null); - /// Create a new subscription. + /// Create a subscription. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateSubscriptionAsync(Subscription subscription, string accessToken = null) where TSubscription : Subscription; @@ -3547,52 +3563,52 @@ public interface IMeResource /// ID of the subscription. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteSubscriptionAsync(string subscriptionID, string accessToken = null); - /// Get a list of subscription items visible to this user. + /// List subscription items visible to this user. /// ID of the subscription. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSubscriptionItemsAsync(string subscriptionID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of subscription items visible to this user. + /// List subscription items visible to this user. /// ID of the subscription. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSubscriptionItemsAsync(string subscriptionID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TLineItem : LineItem; - /// Get a list of subscription items visible to this user. + /// List subscription items visible to this user. /// ID of the subscription. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSubscriptionItemsAsync(string subscriptionID, Action> buildListOpts, string accessToken = null); - /// Get a list of subscription items visible to this user. + /// List subscription items visible to this user. /// ID of the subscription. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSubscriptionItemsAsync(string subscriptionID, Action> buildListOpts, string accessToken = null) where TLineItem : LineItem; - /// Get a single subscription item. + /// Retrieve a subscription item. /// ID of the subscription. /// ID of the subscription item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSubscriptionItemAsync(string subscriptionID, string subscriptionItemID, string accessToken = null); - /// Get a single subscription item. + /// Retrieve a subscription item. /// ID of the subscription. /// ID of the subscription item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetSubscriptionItemAsync(string subscriptionID, string subscriptionItemID, string accessToken = null) where TLineItem : LineItem; - /// Create a new subscription item. + /// Create a subscription item. /// ID of the subscription. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateSubscriptionItemAsync(string subscriptionID, LineItem lineItem, string accessToken = null); - /// Create a new subscription item. + /// Create a subscription item. /// ID of the subscription. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -3626,13 +3642,13 @@ public interface IMeResource /// ID of the subscription item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteSubscriptionItemAsync(string subscriptionID, string subscriptionItemID, string accessToken = null); - /// Create a new subscription bundle item. + /// Create a subscription bundle item. /// ID of the subscription. /// ID of the bundle. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateSubscriptionBundleItemAsync(string subscriptionID, string bundleID, BundleItems bundleItems = null, string accessToken = null); - /// Create a new subscription bundle item. + /// Create a subscription bundle item. /// ID of the subscription. /// ID of the bundle. /// The object that will be serialized to JSON and sent in the request body. @@ -3644,45 +3660,45 @@ public interface IMeResource /// ID of the bundle item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteSubscriptionBundleItemAsync(string subscriptionID, string bundleID, string bundleItemID, string accessToken = null); - /// Features in beta are subject to change and are not available in production. Get a list of group order invitations visible to this user. + /// Features in beta are subject to change and are not available in production. List group order invitations visible to this user. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListGroupOrderInvitationsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Features in beta are subject to change and are not available in production. Get a list of group order invitations visible to this user. + /// Features in beta are subject to change and are not available in production. List group order invitations visible to this user. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListGroupOrderInvitationsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TGroupOrderInvitation : GroupOrderInvitation; - /// Features in beta are subject to change and are not available in production. Get a list of group order invitations visible to this user. + /// Features in beta are subject to change and are not available in production. List group order invitations visible to this user. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListGroupOrderInvitationsAsync(Action> buildListOpts, string accessToken = null); - /// Features in beta are subject to change and are not available in production. Get a list of group order invitations visible to this user. + /// Features in beta are subject to change and are not available in production. List group order invitations visible to this user. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListGroupOrderInvitationsAsync(Action> buildListOpts, string accessToken = null) where TGroupOrderInvitation : GroupOrderInvitation; - /// Features in beta are subject to change and are not available in production. Get a single group order invitation. + /// Features in beta are subject to change and are not available in production. Retrieve a group order invitation. /// ID of the invitation. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetGroupOrderInvitationAsync(string invitationID, string accessToken = null); - /// Features in beta are subject to change and are not available in production. Get a single group order invitation. + /// Features in beta are subject to change and are not available in production. Retrieve a group order invitation. /// ID of the invitation. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetGroupOrderInvitationAsync(string invitationID, string accessToken = null) where TGroupOrderInvitation : GroupOrderInvitation; - /// Features in beta are subject to change and are not available in production. Create a new group order invitation. + /// Features in beta are subject to change and are not available in production. Create a group order invitation. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateGroupOrderInvitationAsync(GroupOrderInvitation groupOrderInvitation, string accessToken = null); - /// Features in beta are subject to change and are not available in production. Create a new group order invitation. + /// Features in beta are subject to change and are not available in production. Create a group order invitation. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateGroupOrderInvitationAsync(GroupOrderInvitation groupOrderInvitation, string accessToken = null) where TGroupOrderInvitation : GroupOrderInvitation; @@ -3700,32 +3716,32 @@ public interface IMeResource /// ID of the invitation. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteGroupOrderInvitationAsync(string invitationID, string accessToken = null); - /// Get a list of product sellers visible to this user. Only available to Buyer Users. + /// List product sellers visible to this user. Only available to Buyer Users. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductSellersAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product sellers visible to this user. Only available to Buyer Users. + /// List product sellers visible to this user. Only available to Buyer Users. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductSellersAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TProductSeller : ProductSeller; - /// Get a list of product sellers visible to this user. Only available to Buyer Users. + /// List product sellers visible to this user. Only available to Buyer Users. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductSellersAsync(string productID, Action> buildListOpts, string accessToken = null); - /// Get a list of product sellers visible to this user. Only available to Buyer Users. + /// List product sellers visible to this user. Only available to Buyer Users. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -3737,45 +3753,45 @@ public interface IMeResource public interface IMessageSendersResource { - /// Get a single message sender. + /// Retrieve a message sender. /// ID of the message sender. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string messageSenderID, string accessToken = null); - /// Get a single message sender. + /// Retrieve a message sender. /// ID of the message sender. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string messageSenderID, string accessToken = null) where TMessageSender : MessageSender; - /// Get a list of message senders. + /// List message senders. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of message senders. + /// List message senders. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TMessageSender : MessageSender; - /// Get a list of message senders. + /// List message senders. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of message senders. + /// List message senders. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TMessageSender : MessageSender; - /// Create a new message sender. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a message sender. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(MessageSender messageSender, string accessToken = null); - /// Create a new message sender. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a message sender. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(MessageSender messageSender, string accessToken = null) where TMessageSender : MessageSender; @@ -3803,14 +3819,14 @@ public interface IMessageSendersResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string messageSenderID, PartialMessageSender partialMessageSender, string accessToken = null) where TMessageSender : MessageSender; - /// Get a list of message sender assignments. + /// List message sender assignments. /// ID of the buyer. /// ID of the message sender. /// ID of the user. /// ID of the user group. /// Level of the message sender assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// ID of the supplier. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string buyerID = null, string messageSenderID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string supplierID = null, string accessToken = null); @@ -3826,16 +3842,16 @@ public interface IMessageSendersResource /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAssignmentAsync(MessageSenderAssignment messageSenderAssignment, string accessToken = null); - /// Get a list of message sender cc listener assignments. + /// List message sender cc listener assignments. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCCListenerAssignmentsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of message sender cc listener assignments. + /// List message sender cc listener assignments. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListCCListenerAssignmentsAsync(Action> buildListOpts, string accessToken = null); @@ -3847,37 +3863,37 @@ public interface IMessageSendersResource public interface IOpenIdConnectsResource { - /// Get a single OpenID Connect. + /// Retrieve an OpenID Connect. /// ID of the openidconnect. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string openidconnectID, string accessToken = null); - /// Get a list of OpenID Connects. + /// List OpenID Connects. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of OpenID Connects. + /// List OpenID Connects. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Create a new OpenID Connect. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an OpenID Connect. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OpenIdConnect openIdConnect, string accessToken = null); - /// Create or update a OpenID Connect. If an object with the same ID already exists, it will be overwritten. + /// Create or update an OpenID Connect. If an object with the same ID already exists, it will be overwritten. /// ID of the openidconnect. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAsync(string openidconnectID, OpenIdConnect openIdConnect, string accessToken = null); - /// Delete a OpenID Connect. + /// Delete an OpenID Connect. /// ID of the openidconnect. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAsync(string openidconnectID, string accessToken = null); - /// Partially update a OpenID Connect. + /// Partially update an OpenID Connect. /// ID of the openidconnect. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -3886,49 +3902,49 @@ public interface IOpenIdConnectsResource public interface IOrderReturnsResource { - /// Get a single order return. + /// Retrieve an order return. /// ID of the return. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string returnID, string accessToken = null); - /// Get a single order return. + /// Retrieve an order return. /// ID of the return. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string returnID, string accessToken = null) where TOrderReturn : OrderReturn; - /// Get a list of order returns. + /// List order returns. /// Only returns orders awaiting the user's approval if true. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(bool approvable = false, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of order returns. + /// List order returns. /// Only returns orders awaiting the user's approval if true. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(bool approvable = false, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TOrderReturn : OrderReturn; - /// Get a list of order returns. + /// List order returns. /// A lambda or function for specifying various list options fluently. /// Only returns orders awaiting the user's approval if true. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, bool approvable = false, string accessToken = null); - /// Get a list of order returns. + /// List order returns. /// A lambda or function for specifying various list options fluently. /// Only returns orders awaiting the user's approval if true. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, bool approvable = false, string accessToken = null) where TOrderReturn : OrderReturn; - /// Create a new order return. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an order return. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderReturn orderReturn, string accessToken = null); - /// Create a new order return. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create an order return. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderReturn orderReturn, string accessToken = null) where TOrderReturn : OrderReturn; @@ -3966,106 +3982,106 @@ public interface IOrderReturnsResource /// ID of the line item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteItemAsync(string returnID, string lineItemID, string accessToken = null) where TOrderReturn : OrderReturn; - /// Cancel an OrderReturn. + /// Cancel an order return /// ID of the return. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CancelAsync(string returnID, string accessToken = null); - /// Cancel an OrderReturn. + /// Cancel an order return /// ID of the return. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CancelAsync(string returnID, string accessToken = null) where TOrderReturn : OrderReturn; - /// Complete an OrderReturn. Use only when an order return won't have an associated payment. You will not to reopen an order return after completing it. + /// Complete an order return Use only when an order return won't have an associated payment. You will not to reopen an order return after completing it. /// ID of the return. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CompleteAsync(string returnID, string accessToken = null); - /// Complete an OrderReturn. Use only when an order return won't have an associated payment. You will not to reopen an order return after completing it. + /// Complete an order return Use only when an order return won't have an associated payment. You will not to reopen an order return after completing it. /// ID of the return. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CompleteAsync(string returnID, string accessToken = null) where TOrderReturn : OrderReturn; - /// Submit an order return. + /// Submit an order return /// ID of the return. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SubmitAsync(string returnID, string accessToken = null); - /// Submit an order return. + /// Submit an order return /// ID of the return. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SubmitAsync(string returnID, string accessToken = null) where TOrderReturn : OrderReturn; - /// Get a list of order return approvals. Returns all Approvals associated with the Order Return. + /// List order return approvals. Returns all Approvals associated with the Order Return. /// ID of the return. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovalsAsync(string returnID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of order return approvals. Returns all Approvals associated with the Order Return. + /// List order return approvals. Returns all Approvals associated with the Order Return. /// ID of the return. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovalsAsync(string returnID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TOrderReturnApproval : OrderReturnApproval; - /// Get a list of order return approvals. Returns all Approvals associated with the Order Return. + /// List order return approvals. Returns all Approvals associated with the Order Return. /// ID of the return. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovalsAsync(string returnID, Action> buildListOpts, string accessToken = null); - /// Get a list of order return approvals. Returns all Approvals associated with the Order Return. + /// List order return approvals. Returns all Approvals associated with the Order Return. /// ID of the return. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovalsAsync(string returnID, Action> buildListOpts, string accessToken = null) where TOrderReturnApproval : OrderReturnApproval; - /// Get a list of order return eligible approvers. Returns all Users who can approve or decline this order return (but have not done so). + /// List order return eligible approvers. Returns all Users who can approve or decline this order return (but have not done so). /// ID of the return. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligibleApproversAsync(string returnID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of order return eligible approvers. Returns all Users who can approve or decline this order return (but have not done so). + /// List order return eligible approvers. Returns all Users who can approve or decline this order return (but have not done so). /// ID of the return. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligibleApproversAsync(string returnID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUser : User; - /// Get a list of order return eligible approvers. Returns all Users who can approve or decline this order return (but have not done so). + /// List order return eligible approvers. Returns all Users who can approve or decline this order return (but have not done so). /// ID of the return. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligibleApproversAsync(string returnID, Action> buildListOpts, string accessToken = null); - /// Get a list of order return eligible approvers. Returns all Users who can approve or decline this order return (but have not done so). + /// List order return eligible approvers. Returns all Users who can approve or decline this order return (but have not done so). /// ID of the return. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligibleApproversAsync(string returnID, Action> buildListOpts, string accessToken = null) where TUser : User; - /// Approve an order return. + /// Approve an order return /// ID of the return. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ApproveAsync(string returnID, ApprovalInfo approvalInfo = null, string accessToken = null); - /// Approve an order return. + /// Approve an order return /// ID of the return. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ApproveAsync(string returnID, ApprovalInfo approvalInfo = null, string accessToken = null) where TOrderReturn : OrderReturn; - /// Decline an order return. + /// Decline an order return /// ID of the return. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeclineAsync(string returnID, ApprovalInfo approvalInfo = null, string accessToken = null); - /// Decline an order return. + /// Decline an order return /// ID of the return. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -4074,48 +4090,48 @@ public interface IOrderReturnsResource public interface IOrdersResource { - /// Get a single order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Retrieve an order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Get a single order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Retrieve an order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrder : Order; - /// Get a list of orders. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List orders. + /// Direction of the order, from the current user's perspective. /// ID of the buyer. /// ID of the supplier. /// Lower bound of date range that the order was created. /// Upper bound of date range that the order was created. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string buyerID = null, string supplierID = null, DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of orders. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List orders. + /// Direction of the order, from the current user's perspective. /// ID of the buyer. /// ID of the supplier. /// Lower bound of date range that the order was created. /// Upper bound of date range that the order was created. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string buyerID = null, string supplierID = null, DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TOrder : Order; - /// Get a list of orders. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List orders. + /// Direction of the order, from the current user's perspective. /// A lambda or function for specifying various list options fluently. /// ID of the buyer. /// ID of the supplier. @@ -4123,8 +4139,8 @@ public interface IOrdersResource /// Upper bound of date range that the order was created. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, Action> buildListOpts, string buyerID = null, string supplierID = null, DateTimeOffset? from = null, DateTimeOffset? to = null, string accessToken = null); - /// Get a list of orders. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List orders. + /// Direction of the order, from the current user's perspective. /// A lambda or function for specifying various list options fluently. /// ID of the buyer. /// ID of the supplier. @@ -4132,407 +4148,407 @@ public interface IOrdersResource /// Upper bound of date range that the order was created. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, Action> buildListOpts, string buyerID = null, string supplierID = null, DateTimeOffset? from = null, DateTimeOffset? to = null, string accessToken = null) where TOrder : Order; - /// Create a new order. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create an order. + /// Direction of the order, from the current user's perspective. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderDirection direction, Order order = null, string accessToken = null); - /// Create a new order. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create an order. + /// Direction of the order, from the current user's perspective. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderDirection direction, Order order = null, string accessToken = null) where TOrder : Order; /// Create or update an order. If an object with the same ID already exists, it will be overwritten. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAsync(OrderDirection direction, string orderID, Order order, string accessToken = null); /// Create or update an order. If an object with the same ID already exists, it will be overwritten. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAsync(OrderDirection direction, string orderID, Order order, string accessToken = null) where TOrder : Order; /// Delete an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Get a list of order approvals. Returns all Approvals associated with the Order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order approvals. Returns all Approvals associated with the Order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovalsAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of order approvals. Returns all Approvals associated with the Order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order approvals. Returns all Approvals associated with the Order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovalsAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TOrderApproval : OrderApproval; - /// Get a list of order approvals. Returns all Approvals associated with the Order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order approvals. Returns all Approvals associated with the Order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovalsAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null); - /// Get a list of order approvals. Returns all Approvals associated with the Order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order approvals. Returns all Approvals associated with the Order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListApprovalsAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null) where TOrderApproval : OrderApproval; - /// Get a list of order eligible approvers. Returns all Users who can approve or decline this order (but have not done so). - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order eligible approvers. Returns all Users who can approve or decline this order (but have not done so). + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligibleApproversAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of order eligible approvers. Returns all Users who can approve or decline this order (but have not done so). - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order eligible approvers. Returns all Users who can approve or decline this order (but have not done so). + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligibleApproversAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUser : User; - /// Get a list of order eligible approvers. Returns all Users who can approve or decline this order (but have not done so). - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order eligible approvers. Returns all Users who can approve or decline this order (but have not done so). + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligibleApproversAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null); - /// Get a list of order eligible approvers. Returns all Users who can approve or decline this order (but have not done so). - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order eligible approvers. Returns all Users who can approve or decline this order (but have not done so). + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligibleApproversAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null) where TUser : User; /// Partially update an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(OrderDirection direction, string orderID, PartialOrder partialOrder, string accessToken = null); /// Partially update an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(OrderDirection direction, string orderID, PartialOrder partialOrder, string accessToken = null) where TOrder : Order; - /// Submit an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Submit an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SubmitAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Submit an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Submit an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SubmitAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrder : Order; - /// Approve an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Approve an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ApproveAsync(OrderDirection direction, string orderID, OrderApprovalInfo orderApprovalInfo = null, string accessToken = null); - /// Approve an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Approve an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ApproveAsync(OrderDirection direction, string orderID, OrderApprovalInfo orderApprovalInfo = null, string accessToken = null) where TOrder : Order; - /// Decline an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Decline an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeclineAsync(OrderDirection direction, string orderID, OrderApprovalInfo orderApprovalInfo = null, string accessToken = null); - /// Decline an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Decline an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeclineAsync(OrderDirection direction, string orderID, OrderApprovalInfo orderApprovalInfo = null, string accessToken = null) where TOrder : Order; - /// Cancel an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Cancel an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CancelAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Cancel an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Cancel an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CancelAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrder : Order; - /// Split an order. Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Split an order Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SplitAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Split an order. Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Split an order Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SplitAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrderSplitResult : OrderSplitResult; - /// Forward an order. Creates and submits 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Forward an order Creates and submits 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ForwardAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Forward an order. Creates and submits 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Forward an order Creates and submits 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ForwardAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrderSplitResult : OrderSplitResult; - /// Complete an order. Use only when an order doesn't need a shipment. You will not be able to ship or reopen an order after completing it. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Complete an order Use only when an order doesn't need a shipment. You will not be able to ship or reopen an order after completing it. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CompleteAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Complete an order. Use only when an order doesn't need a shipment. You will not be able to ship or reopen an order after completing it. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Complete an order Use only when an order doesn't need a shipment. You will not be able to ship or reopen an order after completing it. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CompleteAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrder : Order; - /// Create a new shipment containing all items on an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a new shipment containing all items on an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ShipAsync(OrderDirection direction, string orderID, Shipment shipment, string accessToken = null); - /// Create a new shipment containing all items on an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a new shipment containing all items on an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ShipAsync(OrderDirection direction, string orderID, Shipment shipment, string accessToken = null) where TOrder : Order; - /// List shipments for an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List shipments for an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentsAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// List shipments for an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List shipments for an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentsAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TShipment : Shipment; - /// List shipments for an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List shipments for an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentsAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null); - /// List shipments for an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List shipments for an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListShipmentsAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null) where TShipment : Shipment; - /// Set a shipping address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Set a shipping address + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShippingAddressAsync(OrderDirection direction, string orderID, Address address, string accessToken = null); - /// Set a shipping address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Set a shipping address + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShippingAddressAsync(OrderDirection direction, string orderID, Address address, string accessToken = null) where TOrder : Order; /// Partially update an order shipping address. Not allowed on unsubmitted orders where ShippingAddressID has been set. In that case, use the Addresses resource to update the saved address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchShippingAddressAsync(OrderDirection direction, string orderID, PartialAddress partialAddress, string accessToken = null); /// Partially update an order shipping address. Not allowed on unsubmitted orders where ShippingAddressID has been set. In that case, use the Addresses resource to update the saved address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchShippingAddressAsync(OrderDirection direction, string orderID, PartialAddress partialAddress, string accessToken = null) where TOrder : Order; - /// Set a billing address. Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Set a billing address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetBillingAddressAsync(OrderDirection direction, string orderID, Address address, string accessToken = null); - /// Set a billing address. Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Set a billing address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetBillingAddressAsync(OrderDirection direction, string orderID, Address address, string accessToken = null) where TOrder : Order; /// Partially update an order billing address. Not allowed on unsubmitted orders where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchBillingAddressAsync(OrderDirection direction, string orderID, PartialAddress partialAddress, string accessToken = null); /// Partially update an order billing address. Not allowed on unsubmitted orders where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchBillingAddressAsync(OrderDirection direction, string orderID, PartialAddress partialAddress, string accessToken = null) where TOrder : Order; - /// Update order FromUser. Only FirstName, LastName, and Email can be updated. Primarily used to facilitate guest checkout scenarios. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Partially update an order from user. Only FirstName, LastName, and Email can be updated. Primarily used to facilitate guest checkout scenarios. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchFromUserAsync(OrderDirection direction, string orderID, PartialUser partialUser, string accessToken = null); - /// Update order FromUser. Only FirstName, LastName, and Email can be updated. Primarily used to facilitate guest checkout scenarios. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Partially update an order from user. Only FirstName, LastName, and Email can be updated. Primarily used to facilitate guest checkout scenarios. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchFromUserAsync(OrderDirection direction, string orderID, PartialUser partialUser, string accessToken = null) where TOrder : Order; - /// List eligible promotions. Get a list of promotions eligible for an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List eligible promotions for an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligiblePromotionsAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// List eligible promotions. Get a list of promotions eligible for an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List eligible promotions for an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligiblePromotionsAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TEligiblePromotion : EligiblePromotion; - /// List eligible promotions. Get a list of promotions eligible for an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List eligible promotions for an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligiblePromotionsAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null); - /// List eligible promotions. Get a list of promotions eligible for an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List eligible promotions for an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEligiblePromotionsAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null) where TEligiblePromotion : EligiblePromotion; - /// Add a promotion to an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Add a promotion to an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Promo code of the order promotion. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task AddPromotionAsync(OrderDirection direction, string orderID, string promoCode, string accessToken = null); - /// Add a promotion to an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Add a promotion to an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Promo code of the order promotion. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task AddPromotionAsync(OrderDirection direction, string orderID, string promoCode, string accessToken = null) where TOrderPromotion : OrderPromotion; - /// Get a list of order promotions. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order promotions. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of order promotions. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order promotions. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TOrderPromotion : OrderPromotion; - /// Get a list of order promotions. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order promotions. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null); - /// Get a list of order promotions. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List order promotions. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListPromotionsAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null) where TOrderPromotion : OrderPromotion; - /// Remove a promotion from an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Remove a promotion from an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Promo code of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task RemovePromotionAsync(OrderDirection direction, string orderID, string promoCode, string accessToken = null); - /// Remove a promotion from an order. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Remove a promotion from an order + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Promo code of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task RemovePromotionAsync(OrderDirection direction, string orderID, string promoCode, string accessToken = null) where TOrder : Order; - /// Auto-apply promotions to an order. Apply up to 100 eligible promotions where AutoApply=true. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Auto-apply promotions to an order Apply up to 100 eligible promotions where AutoApply=true. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ApplyPromotionsAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Auto-apply promotions to an order. Apply up to 100 eligible promotions where AutoApply=true. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Auto-apply promotions to an order Apply up to 100 eligible promotions where AutoApply=true. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ApplyPromotionsAsync(OrderDirection direction, string orderID, string accessToken = null) where TOrder : Order; - /// Refresh promotions on an order. Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100) - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Refresh promotions on an order Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100) + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task RefreshPromotionsAsync(OrderDirection direction, string orderID, string accessToken = null); - /// Refresh promotions on an order. Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100) - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Refresh promotions on an order Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100) + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task RefreshPromotionsAsync(OrderDirection direction, string orderID, string accessToken = null) where TRefreshPromosResponse : RefreshPromosResponse; - /// Validate an order in its current state. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Validate an order in its current state + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task ValidateAsync(OrderDirection direction, string orderID, string accessToken = null); @@ -4540,7 +4556,7 @@ public interface IOrdersResource public interface IOrderSyncsResource { - /// Get a single order sync. + /// Retrieve an order sync. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null); /// Delete an order sync. @@ -4558,100 +4574,100 @@ public interface IOrderSyncsResource public interface IPaymentsResource { - /// Get a single payment. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Retrieve a payment. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the payment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(OrderDirection direction, string orderID, string paymentID, string accessToken = null); - /// Get a single payment. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Retrieve a payment. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the payment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(OrderDirection direction, string orderID, string paymentID, string accessToken = null) where TPayment : Payment; - /// Get a list of payments. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List payments. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of payments. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List payments. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string orderID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TPayment : Payment; - /// Get a list of payments. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List payments. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null); - /// Get a list of payments. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// List payments. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(OrderDirection direction, string orderID, Action> buildListOpts, string accessToken = null) where TPayment : Payment; - /// Create a new payment. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a payment. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderDirection direction, string orderID, Payment payment, string accessToken = null); - /// Create a new payment. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a payment. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(OrderDirection direction, string orderID, Payment payment, string accessToken = null) where TPayment : Payment; /// Delete a payment. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the payment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAsync(OrderDirection direction, string orderID, string paymentID, string accessToken = null); /// Partially update a payment. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the payment. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(OrderDirection direction, string orderID, string paymentID, PartialPayment partialPayment, string accessToken = null); /// Partially update a payment. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the payment. /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(OrderDirection direction, string orderID, string paymentID, PartialPayment partialPayment, string accessToken = null) where TPayment : Payment; - /// Create a new payment transaction. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a payment transaction. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the payment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateTransactionAsync(OrderDirection direction, string orderID, string paymentID, PaymentTransaction paymentTransaction, string accessToken = null); - /// Create a new payment transaction. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Create a payment transaction. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the payment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateTransactionAsync(OrderDirection direction, string orderID, string paymentID, PaymentTransaction paymentTransaction, string accessToken = null) where TPayment : Payment; /// Delete a payment transaction. - /// Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. + /// Direction of the order, from the current user's perspective. /// ID of the order. /// ID of the payment. /// ID of the transaction. @@ -4661,45 +4677,45 @@ public interface IPaymentsResource public interface IPriceSchedulesResource { - /// Get a single price schedule. + /// Retrieve a price schedule. /// ID of the price schedule. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string priceScheduleID, string accessToken = null); - /// Get a single price schedule. + /// Retrieve a price schedule. /// ID of the price schedule. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string priceScheduleID, string accessToken = null) where TPriceSchedule : PriceSchedule; - /// Get a list of price schedules. + /// List price schedules. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of price schedules. + /// List price schedules. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TPriceSchedule : PriceSchedule; - /// Get a list of price schedules. + /// List price schedules. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of price schedules. + /// List price schedules. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TPriceSchedule : PriceSchedule; - /// Create a new price schedule. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a price schedule. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(PriceSchedule priceSchedule, string accessToken = null); - /// Create a new price schedule. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a price schedule. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(PriceSchedule priceSchedule, string accessToken = null) where TPriceSchedule : PriceSchedule; @@ -4746,77 +4762,77 @@ public interface IPriceSchedulesResource public interface IProductCollectionsResource { - /// Get a single product collection. + /// Retrieve a product collection. /// ID of the buyer. /// ID of the product collection. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string productCollectionID, string accessToken = null); - /// Get a single product collection. + /// Retrieve a product collection. /// ID of the buyer. /// ID of the product collection. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string productCollectionID, string accessToken = null) where TProductCollection : ProductCollection; - /// Get a list of product collections. + /// List product collections. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product collections. + /// List product collections. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TProductCollection : ProductCollection; - /// Get a list of product collections. + /// List product collections. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null); - /// Get a list of product collections. + /// List product collections. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null) where TProductCollection : ProductCollection; - /// Get a list of product collection entries. + /// List product collection entries. /// ID of the buyer. /// ID of the product collection. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEntriesAsync(string buyerID, string productCollectionID, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product collection entries. + /// List product collection entries. /// ID of the buyer. /// ID of the product collection. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEntriesAsync(string buyerID, string productCollectionID, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TProductCollectionProduct : ProductCollectionProduct; - /// Get a list of product collection entries. + /// List product collection entries. /// ID of the buyer. /// ID of the product collection. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListEntriesAsync(string buyerID, string productCollectionID, Action> buildListOpts, string accessToken = null); - /// Get a list of product collection entries. + /// List product collection entries. /// ID of the buyer. /// ID of the product collection. /// A lambda or function for specifying various list options fluently. @@ -4826,45 +4842,45 @@ public interface IProductCollectionsResource public interface IProductFacetsResource { - /// Get a single product facet. + /// Retrieve a product facet. /// ID of the product facet. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string productFacetID, string accessToken = null); - /// Get a single product facet. + /// Retrieve a product facet. /// ID of the product facet. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string productFacetID, string accessToken = null) where TProductFacet : ProductFacet; - /// Get a list of product facets. + /// List product facets. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product facets. + /// List product facets. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TProductFacet : ProductFacet; - /// Get a list of product facets. + /// List product facets. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of product facets. + /// List product facets. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TProductFacet : ProductFacet; - /// Create a new product facet. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a product facet. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(ProductFacet productFacet, string accessToken = null); - /// Create a new product facet. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a product facet. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(ProductFacet productFacet, string accessToken = null) where TProductFacet : ProductFacet; @@ -4896,59 +4912,59 @@ public interface IProductFacetsResource public interface IProductsResource { - /// Get a single product. + /// Retrieve a product. /// ID of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string productID, string accessToken = null); - /// Get a single product. + /// Retrieve a product. /// ID of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string productID, string accessToken = null) where TProduct : Product; - /// Get a list of products. + /// List products. /// ID of the catalog. /// ID of the category. /// ID of the supplier. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string catalogID = null, string categoryID = null, string supplierID = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of products. + /// List products. /// ID of the catalog. /// ID of the category. /// ID of the supplier. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. - /// Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix. + /// Type of search to perform. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string catalogID = null, string categoryID = null, string supplierID = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TProduct : Product; - /// Get a list of products. + /// List products. /// A lambda or function for specifying various list options fluently. /// ID of the catalog. /// ID of the category. /// ID of the supplier. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string catalogID = null, string categoryID = null, string supplierID = null, string accessToken = null); - /// Get a list of products. + /// List products. /// A lambda or function for specifying various list options fluently. /// ID of the catalog. /// ID of the category. /// ID of the supplier. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string catalogID = null, string categoryID = null, string supplierID = null, string accessToken = null) where TProduct : Product; - /// Create a new product. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a product. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Product product, string accessToken = null); - /// Create a new product. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a product. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Product product, string accessToken = null) where TProduct : Product; @@ -4976,55 +4992,55 @@ public interface IProductsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string productID, PartialProduct partialProduct, string accessToken = null) where TProduct : Product; - /// Generate variants. + /// Generate variants /// ID of the product. /// The object that will be serialized to JSON and sent in the request body. /// Overwrite existing of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GenerateVariantsAsync(string productID, VariantOverrides variantOverrides = null, bool overwriteExisting = false, string accessToken = null); - /// Generate variants. + /// Generate variants /// ID of the product. /// The object that will be serialized to JSON and sent in the request body. /// Overwrite existing of the product. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GenerateVariantsAsync(string productID, VariantOverrides variantOverrides = null, bool overwriteExisting = false, string accessToken = null) where TProduct : Product; - /// Get a list of product variants. + /// List product variants. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListVariantsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product variants. + /// List product variants. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListVariantsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TVariant : Variant; - /// Get a list of product variants. + /// List product variants. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListVariantsAsync(string productID, Action> buildListOpts, string accessToken = null); - /// Get a list of product variants. + /// List product variants. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListVariantsAsync(string productID, Action> buildListOpts, string accessToken = null) where TVariant : Variant; - /// Update a product variant. Update a product variant. + /// Update a product variant Update a product variant. /// ID of the product. /// ID of the variant. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveVariantAsync(string productID, string variantID, Variant variant, string accessToken = null); - /// Update a product variant. Update a product variant. + /// Update a product variant Update a product variant. /// ID of the product. /// ID of the variant. /// The object that will be serialized to JSON and sent in the request body. @@ -5042,72 +5058,72 @@ public interface IProductsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchVariantAsync(string productID, string variantID, PartialVariant partialVariant, string accessToken = null) where TVariant : Variant; - /// Get a single product variant. + /// Retrieve a product variant. /// ID of the product. /// ID of the variant. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetVariantAsync(string productID, string variantID, string accessToken = null); - /// Get a single product variant. + /// Retrieve a product variant. /// ID of the product. /// ID of the variant. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetVariantAsync(string productID, string variantID, string accessToken = null) where TVariant : Variant; - /// Get a list of product specs. + /// List product specs. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpecsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product specs. + /// List product specs. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpecsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSpec : Spec; - /// Get a list of product specs. + /// List product specs. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpecsAsync(string productID, Action> buildListOpts, string accessToken = null); - /// Get a list of product specs. + /// List product specs. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSpecsAsync(string productID, Action> buildListOpts, string accessToken = null) where TSpec : Spec; - /// Get a list of product suppliers. + /// List product suppliers. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSuppliersAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of product suppliers. + /// List product suppliers. /// ID of the product. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSuppliersAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TProductSupplier : ProductSupplier; - /// Get a list of product suppliers. + /// List product suppliers. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListSuppliersAsync(string productID, Action> buildListOpts, string accessToken = null); - /// Get a list of product suppliers. + /// List product suppliers. /// ID of the product. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -5118,7 +5134,7 @@ public interface IProductsResource /// ID of the default price schedule. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveSupplierAsync(string productID, string supplierID, string defaultPriceScheduleID = null, string accessToken = null); - /// Remove a product supplier. + /// Remove a product supplier /// ID of the product. /// ID of the supplier. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -5127,15 +5143,15 @@ public interface IProductsResource /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveAssignmentAsync(ProductAssignment productAssignment, string accessToken = null); - /// Get a list of product assignments. + /// List product assignments. /// ID of the product. /// ID of the price schedule. /// ID of the buyer. /// ID of the user. /// ID of the user group. /// Level of the product assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string productID = null, string priceScheduleID = null, string buyerID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Delete a product assignment. @@ -5150,7 +5166,7 @@ public interface IProductsResource public interface IProductSyncsResource { - /// Get a single product sync. + /// Retrieve a product sync. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null); /// Delete a product sync. @@ -5164,7 +5180,7 @@ public interface IProductSyncsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(PartialProductSyncConfig partialProductSyncConfig, string accessToken = null); - /// Sync a product. + /// Sync a product /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SyncAsync(SyncProduct syncProduct, string accessToken = null); @@ -5172,7 +5188,7 @@ public interface IProductSyncsResource public interface IPromotionIntegrationsResource { - /// Get a single promotion integration. + /// Retrieve a promotion integration. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null); /// Delete a promotion integration. @@ -5190,45 +5206,45 @@ public interface IPromotionIntegrationsResource public interface IPromotionsResource { - /// Get a single promotion. + /// Retrieve a promotion. /// ID of the promotion. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string promotionID, string accessToken = null); - /// Get a single promotion. + /// Retrieve a promotion. /// ID of the promotion. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string promotionID, string accessToken = null) where TPromotion : Promotion; - /// Get a list of promotions. + /// List promotions. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of promotions. + /// List promotions. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TPromotion : Promotion; - /// Get a list of promotions. + /// List promotions. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of promotions. + /// List promotions. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TPromotion : Promotion; - /// Create a new promotion. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a promotion. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Promotion promotion, string accessToken = null); - /// Create a new promotion. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a promotion. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Promotion promotion, string accessToken = null) where TPromotion : Promotion; @@ -5256,14 +5272,14 @@ public interface IPromotionsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string promotionID, PartialPromotion partialPromotion, string accessToken = null) where TPromotion : Promotion; - /// Get a list of promotion assignments. + /// List promotion assignments. /// ID of the buyer. /// ID of the promotion. /// ID of the user. /// ID of the user group. /// Level of the promotion assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string buyerID = null, string promotionID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Create or update a promotion assignment. @@ -5281,24 +5297,24 @@ public interface IPromotionsResource public interface ISecurityProfilesResource { - /// Get a single security profile. + /// Retrieve a security profile. /// ID of the security profile. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string securityProfileID, string accessToken = null); - /// Get a list of security profiles. + /// List security profiles. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of security profiles. + /// List security profiles. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Create a new security profile. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a security profile. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(SecurityProfile securityProfile, string accessToken = null); @@ -5316,7 +5332,7 @@ public interface ISecurityProfilesResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string securityProfileID, PartialSecurityProfile partialSecurityProfile, string accessToken = null); - /// Get a list of security profile assignments. + /// List security profile assignments. /// ID of the buyer. /// ID of the supplier. /// ID of the security profile. @@ -5324,8 +5340,8 @@ public interface ISecurityProfilesResource /// ID of the user group. /// Commerce role of the security profile assignment. Possible values: Buyer, Seller, Supplier. /// Level of the security profile assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string buyerID = null, string supplierID = null, string securityProfileID = null, string userID = null, string userGroupID = null, CommerceRole? commerceRole = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Delete a security profile assignment. @@ -5344,45 +5360,45 @@ public interface ISecurityProfilesResource public interface ISellerApprovalRulesResource { - /// Get a single seller approval rule. + /// Retrieve a seller approval rule. /// ID of the approval rule. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string approvalRuleID, string accessToken = null); - /// Get a single seller approval rule. + /// Retrieve a seller approval rule. /// ID of the approval rule. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string approvalRuleID, string accessToken = null) where TSellerApprovalRule : SellerApprovalRule; - /// Get a list of seller approval rules. + /// List seller approval rules. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of seller approval rules. + /// List seller approval rules. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSellerApprovalRule : SellerApprovalRule; - /// Get a list of seller approval rules. + /// List seller approval rules. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of seller approval rules. + /// List seller approval rules. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TSellerApprovalRule : SellerApprovalRule; - /// Create a new seller approval rule. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a seller approval rule. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(SellerApprovalRule sellerApprovalRule, string accessToken = null); - /// Create a new seller approval rule. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a seller approval rule. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(SellerApprovalRule sellerApprovalRule, string accessToken = null) where TSellerApprovalRule : SellerApprovalRule; @@ -5414,49 +5430,49 @@ public interface ISellerApprovalRulesResource public interface IShipmentsResource { - /// Get a single shipment. + /// Retrieve a shipment. /// ID of the shipment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string shipmentID, string accessToken = null); - /// Get a single shipment. + /// Retrieve a shipment. /// ID of the shipment. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string shipmentID, string accessToken = null) where TShipment : Shipment; - /// Get a list of shipments. + /// List shipments. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string orderID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of shipments. + /// List shipments. /// ID of the order. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string orderID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TShipment : Shipment; - /// Get a list of shipments. + /// List shipments. /// A lambda or function for specifying various list options fluently. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string orderID = null, string accessToken = null); - /// Get a list of shipments. + /// List shipments. /// A lambda or function for specifying various list options fluently. /// ID of the order. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string orderID = null, string accessToken = null) where TShipment : Shipment; - /// Create a new shipment. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a shipment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Shipment shipment, string accessToken = null); - /// Create a new shipment. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a shipment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Shipment shipment, string accessToken = null) where TShipment : Shipment; @@ -5484,63 +5500,63 @@ public interface IShipmentsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string shipmentID, PartialShipment partialShipment, string accessToken = null) where TShipment : Shipment; - /// Set a ship to address. Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's ToAddressID property instead. + /// Set a ship to address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's ToAddressID property instead. /// ID of the shipment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShipToAddressAsync(string shipmentID, Address address, string accessToken = null); - /// Set a ship to address. Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's ToAddressID property instead. + /// Set a ship to address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's ToAddressID property instead. /// ID of the shipment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShipToAddressAsync(string shipmentID, Address address, string accessToken = null) where TShipment : Shipment; - /// Set a ship from address. Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's FromAddressID property instead. + /// Set a ship from address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's FromAddressID property instead. /// ID of the shipment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShipFromAddressAsync(string shipmentID, Address address, string accessToken = null); - /// Set a ship from address. Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's FromAddressID property instead. + /// Set a ship from address Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's FromAddressID property instead. /// ID of the shipment. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SetShipFromAddressAsync(string shipmentID, Address address, string accessToken = null) where TShipment : Shipment; - /// Get a list of shipment items. + /// List shipment items. /// ID of the shipment. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListItemsAsync(string shipmentID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of shipment items. + /// List shipment items. /// ID of the shipment. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListItemsAsync(string shipmentID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TShipmentItem : ShipmentItem; - /// Get a list of shipment items. + /// List shipment items. /// ID of the shipment. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListItemsAsync(string shipmentID, Action> buildListOpts, string accessToken = null); - /// Get a list of shipment items. + /// List shipment items. /// ID of the shipment. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListItemsAsync(string shipmentID, Action> buildListOpts, string accessToken = null) where TShipmentItem : ShipmentItem; - /// Get a single shipment item. + /// Retrieve a shipment item. /// ID of the shipment. /// ID of the order. /// ID of the line item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetItemAsync(string shipmentID, string orderID, string lineItemID, string accessToken = null); - /// Get a single shipment item. + /// Retrieve a shipment item. /// ID of the shipment. /// ID of the order. /// ID of the line item. @@ -5566,45 +5582,45 @@ public interface IShipmentsResource public interface ISpecsResource { - /// Get a single spec. + /// Retrieve a spec. /// ID of the spec. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string specID, string accessToken = null); - /// Get a single spec. + /// Retrieve a spec. /// ID of the spec. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string specID, string accessToken = null) where TSpec : Spec; - /// Get a list of specs. + /// List specs. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of specs. + /// List specs. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSpec : Spec; - /// Get a list of specs. + /// List specs. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of specs. + /// List specs. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TSpec : Spec; - /// Create a new spec. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a spec. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Spec spec, string accessToken = null); - /// Create a new spec. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a spec. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Spec spec, string accessToken = null) where TSpec : Spec; @@ -5632,16 +5648,16 @@ public interface ISpecsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string specID, PartialSpec partialSpec, string accessToken = null) where TSpec : Spec; - /// Get a list of spec product assignments. + /// List spec product assignments. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductAssignmentsAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of spec product assignments. + /// List spec product assignments. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListProductAssignmentsAsync(Action> buildListOpts, string accessToken = null); @@ -5654,42 +5670,42 @@ public interface ISpecsResource /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task SaveProductAssignmentAsync(SpecProductAssignment specProductAssignment, string accessToken = null); - /// Create a new spec option. A Spec can have multiple Options-- for example, if the spec is called 'Color', the options might be 'Blue', 'Red', and 'Green'. + /// Create a spec option. A Spec can have multiple Options-- for example, if the spec is called 'Color', the options might be 'Blue', 'Red', and 'Green'. /// ID of the spec. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateOptionAsync(string specID, SpecOption specOption, string accessToken = null); - /// Create a new spec option. A Spec can have multiple Options-- for example, if the spec is called 'Color', the options might be 'Blue', 'Red', and 'Green'. + /// Create a spec option. A Spec can have multiple Options-- for example, if the spec is called 'Color', the options might be 'Blue', 'Red', and 'Green'. /// ID of the spec. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateOptionAsync(string specID, SpecOption specOption, string accessToken = null) where TSpecOption : SpecOption; - /// Get a list of spec options. + /// List spec options. /// ID of the spec. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListOptionsAsync(string specID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of spec options. + /// List spec options. /// ID of the spec. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListOptionsAsync(string specID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSpecOption : SpecOption; - /// Get a list of spec options. + /// List spec options. /// ID of the spec. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListOptionsAsync(string specID, Action> buildListOpts, string accessToken = null); - /// Get a list of spec options. + /// List spec options. /// ID of the spec. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -5718,12 +5734,12 @@ public interface ISpecsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchOptionAsync(string specID, string optionID, PartialSpecOption partialSpecOption, string accessToken = null) where TSpecOption : SpecOption; - /// Get a single spec option. + /// Retrieve a spec option. /// ID of the spec. /// ID of the option. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetOptionAsync(string specID, string optionID, string accessToken = null); - /// Get a single spec option. + /// Retrieve a spec option. /// ID of the spec. /// ID of the option. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -5737,52 +5753,52 @@ public interface ISpecsResource public interface ISpendingAccountsResource { - /// Get a single spending account. + /// Retrieve a spending account. /// ID of the buyer. /// ID of the spending account. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string spendingAccountID, string accessToken = null); - /// Get a single spending account. + /// Retrieve a spending account. /// ID of the buyer. /// ID of the spending account. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string spendingAccountID, string accessToken = null) where TSpendingAccount : SpendingAccount; - /// Get a list of spending accounts. + /// List spending accounts. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of spending accounts. + /// List spending accounts. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSpendingAccount : SpendingAccount; - /// Get a list of spending accounts. + /// List spending accounts. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null); - /// Get a list of spending accounts. + /// List spending accounts. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null) where TSpendingAccount : SpendingAccount; - /// Create a new spending account. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a spending account. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string buyerID, SpendingAccount spendingAccount, string accessToken = null); - /// Create a new spending account. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a spending account. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -5816,14 +5832,14 @@ public interface ISpendingAccountsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string buyerID, string spendingAccountID, PartialSpendingAccount partialSpendingAccount, string accessToken = null) where TSpendingAccount : SpendingAccount; - /// Get a list of spending account assignments. + /// List spending account assignments. /// ID of the buyer. /// ID of the spending account. /// ID of the user. /// ID of the user group. /// Level of the spending account assignment. Possible values: User, Group, Company. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAssignmentsAsync(string buyerID, string spendingAccountID = null, string userID = null, string userGroupID = null, PartyType? level = null, int? page = null, int? pageSize = null, string accessToken = null); /// Create or update a spending account assignment. @@ -5842,10 +5858,10 @@ public interface ISpendingAccountsResource public interface ISubscriptionIntegrationsResource { - /// Get a single subscription integration. + /// Retrieve a subscription integration. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null); - /// Get a single subscription integration. + /// Retrieve a subscription integration. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string accessToken = null) where TSubscriptionIntegration : SubscriptionIntegration; /// Delete a subscription integration. @@ -5871,52 +5887,52 @@ public interface ISubscriptionIntegrationsResource public interface ISubscriptionItemsResource { - /// Get a single subscription item. + /// Retrieve a subscription item. /// ID of the subscription. /// ID of the subscription item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string subscriptionID, string subscriptionItemID, string accessToken = null); - /// Get a single subscription item. + /// Retrieve a subscription item. /// ID of the subscription. /// ID of the subscription item. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string subscriptionID, string subscriptionItemID, string accessToken = null) where TLineItem : LineItem; - /// Get a list of subscription items. + /// List subscription items. /// ID of the subscription. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string subscriptionID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of subscription items. + /// List subscription items. /// ID of the subscription. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string subscriptionID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TLineItem : LineItem; - /// Get a list of subscription items. + /// List subscription items. /// ID of the subscription. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string subscriptionID, Action> buildListOpts, string accessToken = null); - /// Get a list of subscription items. + /// List subscription items. /// ID of the subscription. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string subscriptionID, Action> buildListOpts, string accessToken = null) where TLineItem : LineItem; - /// Create a new subscription item. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a subscription item. /// ID of the subscription. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string subscriptionID, LineItem lineItem, string accessToken = null); - /// Create a new subscription item. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a subscription item. /// ID of the subscription. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -5954,45 +5970,45 @@ public interface ISubscriptionItemsResource public interface ISubscriptionsResource { - /// Get a single subscription. + /// Retrieve a subscription. /// ID of the subscription. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string subscriptionID, string accessToken = null); - /// Get a single subscription. + /// Retrieve a subscription. /// ID of the subscription. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string subscriptionID, string accessToken = null) where TSubscription : Subscription; - /// Get a list of subscriptions. + /// List subscriptions. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of subscriptions. + /// List subscriptions. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSubscription : Subscription; - /// Get a list of subscriptions. + /// List subscriptions. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of subscriptions. + /// List subscriptions. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TSubscription : Subscription; - /// Create a new subscription. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a subscription. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Subscription subscription, string accessToken = null); - /// Create a new subscription. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a subscription. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Subscription subscription, string accessToken = null) where TSubscription : Subscription; @@ -6024,52 +6040,52 @@ public interface ISubscriptionsResource public interface ISupplierAddressesResource { - /// Get a single supplier address. + /// Retrieve a supplier address. /// ID of the supplier. /// ID of the address. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task
GetAsync(string supplierID, string addressID, string accessToken = null); - /// Get a single supplier address. + /// Retrieve a supplier address. /// ID of the supplier. /// ID of the address. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string supplierID, string addressID, string accessToken = null) where TAddress : Address; - /// Get a list of supplier addresses. + /// List supplier addresses. /// ID of the supplier. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of supplier addresses. + /// List supplier addresses. /// ID of the supplier. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TAddress : Address; - /// Get a list of supplier addresses. + /// List supplier addresses. /// ID of the supplier. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, Action> buildListOpts, string accessToken = null); - /// Get a list of supplier addresses. + /// List supplier addresses. /// ID of the supplier. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, Action> buildListOpts, string accessToken = null) where TAddress : Address; - /// Create a new supplier address. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a supplier address. /// ID of the supplier. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task
CreateAsync(string supplierID, Address address, string accessToken = null); - /// Create a new supplier address. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a supplier address. /// ID of the supplier. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -6107,45 +6123,45 @@ public interface ISupplierAddressesResource public interface ISuppliersResource { - /// Get a single supplier. + /// Retrieve a supplier. /// ID of the supplier. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string supplierID, string accessToken = null); - /// Get a single supplier. + /// Retrieve a supplier. /// ID of the supplier. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string supplierID, string accessToken = null) where TSupplier : Supplier; - /// Get a list of suppliers. + /// List suppliers. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of suppliers. + /// List suppliers. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TSupplier : Supplier; - /// Get a list of suppliers. + /// List suppliers. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of suppliers. + /// List suppliers. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null) where TSupplier : Supplier; - /// Create a new supplier. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a supplier. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Supplier supplier, string accessToken = null); - /// Create a new supplier. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a supplier. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Supplier supplier, string accessToken = null) where TSupplier : Supplier; @@ -6173,17 +6189,17 @@ public interface ISuppliersResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string supplierID, PartialSupplier partialSupplier, string accessToken = null) where TSupplier : Supplier; - /// Get a list of supplier buyers. + /// List supplier buyers. /// ID of the supplier. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListBuyersAsync(string supplierID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of supplier buyers. + /// List supplier buyers. /// ID of the supplier. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -6202,52 +6218,52 @@ public interface ISuppliersResource public interface ISupplierUserGroupsResource { - /// Get a single supplier user group. + /// Retrieve a supplier user group. /// ID of the supplier. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string supplierID, string userGroupID, string accessToken = null); - /// Get a single supplier user group. + /// Retrieve a supplier user group. /// ID of the supplier. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string supplierID, string userGroupID, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of supplier user groups. + /// List supplier user groups. /// ID of the supplier. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of supplier user groups. + /// List supplier user groups. /// ID of the supplier. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of supplier user groups. + /// List supplier user groups. /// ID of the supplier. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, Action> buildListOpts, string accessToken = null); - /// Get a list of supplier user groups. + /// List supplier user groups. /// ID of the supplier. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, Action> buildListOpts, string accessToken = null) where TUserGroup : UserGroup; - /// Create a new supplier user group. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a supplier user group. /// ID of the supplier. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string supplierID, UserGroup userGroup, string accessToken = null); - /// Create a new supplier user group. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a supplier user group. /// ID of the supplier. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -6281,12 +6297,12 @@ public interface ISupplierUserGroupsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string supplierID, string userGroupID, PartialUserGroup partialUserGroup, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of supplier user group user assignments. + /// List supplier user group user assignments. /// ID of the supplier. /// ID of the user group. /// ID of the user. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListUserAssignmentsAsync(string supplierID, string userGroupID = null, string userID = null, int page = 1, int pageSize = 20, string accessToken = null); /// Delete a supplier user group user assignment. @@ -6304,56 +6320,56 @@ public interface ISupplierUserGroupsResource public interface ISupplierUsersResource { - /// Get a single supplier user. + /// Retrieve a supplier user. /// ID of the supplier. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string supplierID, string userID, string accessToken = null); - /// Get a single supplier user. + /// Retrieve a supplier user. /// ID of the supplier. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string supplierID, string userID, string accessToken = null) where TUser : User; - /// Get a list of supplier users. + /// List supplier users. /// ID of the supplier. /// ID of the user group. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, string userGroupID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of supplier users. + /// List supplier users. /// ID of the supplier. /// ID of the user group. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, string userGroupID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUser : User; - /// Get a list of supplier users. + /// List supplier users. /// ID of the supplier. /// A lambda or function for specifying various list options fluently. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, Action> buildListOpts, string userGroupID = null, string accessToken = null); - /// Get a list of supplier users. + /// List supplier users. /// ID of the supplier. /// A lambda or function for specifying various list options fluently. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string supplierID, Action> buildListOpts, string userGroupID = null, string accessToken = null) where TUser : User; - /// Create a new supplier user. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a supplier user. /// ID of the supplier. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string supplierID, User user, string accessToken = null); - /// Create a new supplier user. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a supplier user. /// ID of the supplier. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -6387,12 +6403,12 @@ public interface ISupplierUsersResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string supplierID, string userID, PartialUser partialUser, string accessToken = null) where TUser : User; - /// Unlock a user account. + /// Unlock a user account /// ID of the supplier. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task UnlockUserAccountAsync(string supplierID, string userID, string accessToken = null); - /// Revoke a user tokens. Revokes all security tokens of specified supplier user. + /// Revoke a user tokens Revokes all security tokens of specified supplier user. /// ID of the supplier. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -6401,24 +6417,24 @@ public interface ISupplierUsersResource public interface ITrackingEventsResource { - /// Get a single tracking event. + /// Retrieve a tracking event. /// ID of the event. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string eventID, string accessToken = null); - /// Get a list of tracking events. + /// List tracking events. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of tracking events. + /// List tracking events. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Create a new tracking event. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a tracking event. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(TrackingEvent trackingEvent, string accessToken = null); @@ -6440,52 +6456,52 @@ public interface ITrackingEventsResource public interface IUserGroupsResource { - /// Get a single user group. + /// Retrieve a user group. /// ID of the buyer. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string userGroupID, string accessToken = null); - /// Get a single user group. + /// Retrieve a user group. /// ID of the buyer. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string userGroupID, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of user groups. + /// List user groups. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of user groups. + /// List user groups. /// ID of the buyer. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of user groups. + /// List user groups. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null); - /// Get a list of user groups. + /// List user groups. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string accessToken = null) where TUserGroup : UserGroup; - /// Create a new user group. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a user group. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string buyerID, UserGroup userGroup, string accessToken = null); - /// Create a new user group. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a user group. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -6519,12 +6535,12 @@ public interface IUserGroupsResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string buyerID, string userGroupID, PartialUserGroup partialUserGroup, string accessToken = null) where TUserGroup : UserGroup; - /// Get a list of user group user assignments. + /// List user group user assignments. /// ID of the buyer. /// ID of the user group. /// ID of the user. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListUserAssignmentsAsync(string buyerID, string userGroupID = null, string userID = null, int page = 1, int pageSize = 20, string accessToken = null); /// Delete a user group user assignment. @@ -6542,56 +6558,56 @@ public interface IUserGroupsResource public interface IUsersResource { - /// Get a single user. + /// Retrieve a user. /// ID of the buyer. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string userID, string accessToken = null); - /// Get a single user. + /// Retrieve a user. /// ID of the buyer. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string buyerID, string userID, string accessToken = null) where TUser : User; - /// Get a list of users. + /// List users. /// ID of the buyer. /// ID of the user group. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string userGroupID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of users. + /// List users. /// ID of the buyer. /// ID of the user group. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, string userGroupID = null, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUser : User; - /// Get a list of users. + /// List users. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string userGroupID = null, string accessToken = null); - /// Get a list of users. + /// List users. /// ID of the buyer. /// A lambda or function for specifying various list options fluently. /// ID of the user group. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string buyerID, Action> buildListOpts, string userGroupID = null, string accessToken = null) where TUser : User; - /// Create a new user. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a user. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(string buyerID, User user, string accessToken = null); - /// Create a new user. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a user. /// ID of the buyer. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -6613,29 +6629,29 @@ public interface IUsersResource /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAsync(string buyerID, string userID, string accessToken = null); - /// Get a list of user across buyers. + /// List user across buyers. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAcrossBuyersAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of user across buyers. + /// List user across buyers. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAcrossBuyersAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TUser : User; - /// Get a list of user across buyers. + /// List user across buyers. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAcrossBuyersAsync(Action> buildListOpts, string accessToken = null); - /// Get a list of user across buyers. + /// List user across buyers. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAcrossBuyersAsync(Action> buildListOpts, string accessToken = null) where TUser : User; @@ -6651,32 +6667,32 @@ public interface IUsersResource /// The object that will be partially serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PatchAsync(string buyerID, string userID, PartialUser partialUser, string accessToken = null) where TUser : User; - /// Move a user to a different buyer. + /// Move a user to a different buyer /// ID of the buyer. /// ID of the user. /// ID of the new buyer. /// Orders of the user. Possible values: None, Unsubmitted, All. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task MoveAsync(string buyerID, string userID, string newBuyerID, UserOrderMoveOption orders, string accessToken = null); - /// Move a user to a different buyer. + /// Move a user to a different buyer /// ID of the buyer. /// ID of the user. /// ID of the new buyer. /// Orders of the user. Possible values: None, Unsubmitted, All. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task MoveAsync(string buyerID, string userID, string newBuyerID, UserOrderMoveOption orders, string accessToken = null) where TUser : User; - /// Get a single user access token. + /// Retrieve a user access token. /// ID of the buyer. /// ID of the user. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAccessTokenAsync(string buyerID, string userID, ImpersonateTokenRequest impersonateTokenRequest, string accessToken = null); - /// Unlock a user account. + /// Unlock a user account /// ID of the buyer. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task UnlockUserAccountAsync(string buyerID, string userID, string accessToken = null); - /// Revoke a user tokens. Revokes all security tokens of specified buyer user. + /// Revoke a user tokens Revokes all security tokens of specified buyer user. /// ID of the buyer. /// ID of the user. /// Optional. Use to provide an existing token instead of authenticating implicitly. @@ -6685,24 +6701,24 @@ public interface IUsersResource public interface IWebhooksResource { - /// Get a single webhook. + /// Retrieve a webhook. /// ID of the webhook. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task GetAsync(string webhookID, string accessToken = null); - /// Get a list of webhooks. + /// List webhooks. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of webhooks. + /// List webhooks. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); - /// Create a new webhook. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. + /// Create a webhook. /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task CreateAsync(Webhook webhook, string accessToken = null); @@ -6724,16 +6740,16 @@ public interface IWebhooksResource public interface IXpIndicesResource { - /// Get a list of XP indices. + /// List XP indices. /// Word or phrase to search for. /// Comma-delimited list of fields to search on. /// Comma-delimited list of fields to sort by. - /// Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. - /// Number of results to return per page. Default: 20, max: 100. + /// Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. + /// Number of results to return per page. /// An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null); - /// Get a list of XP indices. + /// List XP indices. /// A lambda or function for specifying various list options fluently. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task> ListAsync(Action> buildListOpts, string accessToken = null); @@ -6742,7 +6758,7 @@ public interface IXpIndicesResource /// Key of the xp index. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task DeleteAsync(XpThingType thingType, string key, string accessToken = null); - /// Create or Update an XP index. + /// Create or update an xp index /// The object that will be serialized to JSON and sent in the request body. /// Optional. Use to provide an existing token instead of authenticating implicitly. Task PutAsync(XpIndex xpIndex, string accessToken = null); @@ -7372,10 +7388,10 @@ public class InventoryRecordsResource : OrderCloudResource, IInventoryRecordsRes internal InventoryRecordsResource(OrderCloudClient client) : base(client) { } public Task GetAsync(string productID, string inventoryRecordID, string accessToken = null) => GetAsync(productID, inventoryRecordID, accessToken); public Task GetAsync(string productID, string inventoryRecordID, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "inventoryrecords", inventoryRecordID).WithOAuthBearerToken(accessToken).GetJsonAsync(); - public Task> ListAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) => ListAsync(productID, search, searchOn, sortBy, page, pageSize, filters, accessToken); - public Task> ListAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { search, searchOn, sortBy, page, pageSize }).SetQueryParams(filters).GetJsonAsync>(); - public Task> ListAsync(string productID, Action> buildListOpts, string accessToken = null) => ListAsync(productID, buildListOpts, accessToken); - public Task> ListAsync(string productID, Action> buildListOpts, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetListOptions(buildListOpts).GetJsonAsync>(); + public Task> ListAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) => ListAsync(productID, search, searchOn, sortBy, page, pageSize, filters, includeAddress, accessToken); + public Task> ListAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { search, searchOn, sortBy, page, pageSize, includeAddress }).SetQueryParams(filters).GetJsonAsync>(); + public Task> ListAsync(string productID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) => ListAsync(productID, buildListOpts, includeAddress, accessToken); + public Task> ListAsync(string productID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { includeAddress }).SetListOptions(buildListOpts).GetJsonAsync>(); public Task CreateAsync(string productID, InventoryRecord inventoryRecord, string accessToken = null) => CreateAsync(productID, inventoryRecord, accessToken); public Task CreateAsync(string productID, InventoryRecord inventoryRecord, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "inventoryrecords").WithOAuthBearerToken(accessToken).PostJsonAsync(ValidateModel(inventoryRecord)).ReceiveJson(); public Task DeleteAsync(string productID, string inventoryRecordID, string accessToken = null) => Request("v1", "products", productID, "inventoryrecords", inventoryRecordID).WithOAuthBearerToken(accessToken).DeleteAsync(); @@ -7383,10 +7399,10 @@ internal InventoryRecordsResource(OrderCloudClient client) : base(client) { } public Task SaveAsync(string productID, string inventoryRecordID, InventoryRecord inventoryRecord, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "inventoryrecords", inventoryRecordID).WithOAuthBearerToken(accessToken).PutJsonAsync(ValidateModel(inventoryRecord)).ReceiveJson(); public Task PatchAsync(string productID, string inventoryRecordID, PartialInventoryRecord partialInventoryRecord, string accessToken = null) => PatchAsync(productID, inventoryRecordID, partialInventoryRecord, accessToken); public Task PatchAsync(string productID, string inventoryRecordID, PartialInventoryRecord partialInventoryRecord, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "inventoryrecords", inventoryRecordID).WithOAuthBearerToken(accessToken).PatchJsonAsync(ValidateModel(partialInventoryRecord)).ReceiveJson(); - public Task> ListVariantAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) => ListVariantAsync(productID, variantID, search, searchOn, sortBy, page, pageSize, filters, accessToken); - public Task> ListVariantAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "variants", variantID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { search, searchOn, sortBy, page, pageSize }).SetQueryParams(filters).GetJsonAsync>(); - public Task> ListVariantAsync(string productID, string variantID, Action> buildListOpts, string accessToken = null) => ListVariantAsync(productID, variantID, buildListOpts, accessToken); - public Task> ListVariantAsync(string productID, string variantID, Action> buildListOpts, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "variants", variantID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetListOptions(buildListOpts).GetJsonAsync>(); + public Task> ListVariantAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) => ListVariantAsync(productID, variantID, search, searchOn, sortBy, page, pageSize, filters, includeAddress, accessToken); + public Task> ListVariantAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "variants", variantID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { search, searchOn, sortBy, page, pageSize, includeAddress }).SetQueryParams(filters).GetJsonAsync>(); + public Task> ListVariantAsync(string productID, string variantID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) => ListVariantAsync(productID, variantID, buildListOpts, includeAddress, accessToken); + public Task> ListVariantAsync(string productID, string variantID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "variants", variantID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { includeAddress }).SetListOptions(buildListOpts).GetJsonAsync>(); public Task GetVariantAsync(string productID, string variantID, string inventoryRecordID, string accessToken = null) => GetVariantAsync(productID, variantID, inventoryRecordID, accessToken); public Task GetVariantAsync(string productID, string variantID, string inventoryRecordID, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "products", productID, "variants", variantID, "inventoryrecords", inventoryRecordID).WithOAuthBearerToken(accessToken).GetJsonAsync(); public Task CreateVariantAsync(string productID, string variantID, InventoryRecord inventoryRecord, string accessToken = null) => CreateVariantAsync(productID, variantID, inventoryRecord, accessToken); @@ -7510,14 +7526,14 @@ internal MeResource(OrderCloudClient client) : base(client) { } public Task> ListVariantsAsync(string productID, Action> buildListOpts, string accessToken = null) where TVariant : Variant => Request("v1", "me", "products", productID, "variants").WithOAuthBearerToken(accessToken).SetListOptions(buildListOpts).GetJsonAsync>(); public Task GetVariantAsync(string productID, string variantID, string accessToken = null) => GetVariantAsync(productID, variantID, accessToken); public Task GetVariantAsync(string productID, string variantID, string accessToken = null) where TVariant : Variant => Request("v1", "me", "products", productID, "variants", variantID).WithOAuthBearerToken(accessToken).GetJsonAsync(); - public Task> ListProductInventoryRecordsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) => ListProductInventoryRecordsAsync(productID, search, searchOn, sortBy, page, pageSize, filters, accessToken); - public Task> ListProductInventoryRecordsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "me", "products", productID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { search, searchOn, sortBy, page, pageSize }).SetQueryParams(filters).GetJsonAsync>(); - public Task> ListProductInventoryRecordsAsync(string productID, Action> buildListOpts, string accessToken = null) => ListProductInventoryRecordsAsync(productID, buildListOpts, accessToken); - public Task> ListProductInventoryRecordsAsync(string productID, Action> buildListOpts, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "me", "products", productID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetListOptions(buildListOpts).GetJsonAsync>(); - public Task> ListVariantInventoryRecordsAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) => ListVariantInventoryRecordsAsync(productID, variantID, search, searchOn, sortBy, page, pageSize, filters, accessToken); - public Task> ListVariantInventoryRecordsAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "me", "products", productID, "variants", variantID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { search, searchOn, sortBy, page, pageSize }).SetQueryParams(filters).GetJsonAsync>(); - public Task> ListVariantInventoryRecordsAsync(string productID, string variantID, Action> buildListOpts, string accessToken = null) => ListVariantInventoryRecordsAsync(productID, variantID, buildListOpts, accessToken); - public Task> ListVariantInventoryRecordsAsync(string productID, string variantID, Action> buildListOpts, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "me", "products", productID, "variants", variantID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetListOptions(buildListOpts).GetJsonAsync>(); + public Task> ListProductInventoryRecordsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) => ListProductInventoryRecordsAsync(productID, search, searchOn, sortBy, page, pageSize, filters, includeAddress, accessToken); + public Task> ListProductInventoryRecordsAsync(string productID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "me", "products", productID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { search, searchOn, sortBy, page, pageSize, includeAddress }).SetQueryParams(filters).GetJsonAsync>(); + public Task> ListProductInventoryRecordsAsync(string productID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) => ListProductInventoryRecordsAsync(productID, buildListOpts, includeAddress, accessToken); + public Task> ListProductInventoryRecordsAsync(string productID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "me", "products", productID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { includeAddress }).SetListOptions(buildListOpts).GetJsonAsync>(); + public Task> ListVariantInventoryRecordsAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) => ListVariantInventoryRecordsAsync(productID, variantID, search, searchOn, sortBy, page, pageSize, filters, includeAddress, accessToken); + public Task> ListVariantInventoryRecordsAsync(string productID, string variantID, string search = null, string searchOn = null, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "me", "products", productID, "variants", variantID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { search, searchOn, sortBy, page, pageSize, includeAddress }).SetQueryParams(filters).GetJsonAsync>(); + public Task> ListVariantInventoryRecordsAsync(string productID, string variantID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) => ListVariantInventoryRecordsAsync(productID, variantID, buildListOpts, includeAddress, accessToken); + public Task> ListVariantInventoryRecordsAsync(string productID, string variantID, Action> buildListOpts, bool? includeAddress = null, string accessToken = null) where TInventoryRecord : InventoryRecord => Request("v1", "me", "products", productID, "variants", variantID, "inventoryrecords").WithOAuthBearerToken(accessToken).SetQueryParams(new { includeAddress }).SetListOptions(buildListOpts).GetJsonAsync>(); public Task> ListOrdersAsync(DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) => ListOrdersAsync(from, to, search, searchOn, searchType, sortBy, page, pageSize, filters, accessToken); public Task> ListOrdersAsync(DateTimeOffset? from = null, DateTimeOffset? to = null, string search = null, string searchOn = null, SearchType searchType = SearchType.AnyTerm, string sortBy = null, int page = 1, int pageSize = 20, object filters = null, string accessToken = null) where TOrder : Order => Request("v1", "me", "orders").WithOAuthBearerToken(accessToken).SetQueryParams(new { from, to, search, searchOn, searchType, sortBy, page, pageSize }).SetQueryParams(filters).GetJsonAsync>(); public Task> ListOrdersAsync(Action> buildListOpts, DateTimeOffset? from = null, DateTimeOffset? to = null, string accessToken = null) => ListOrdersAsync(buildListOpts, from, to, accessToken); diff --git a/src/OrderCloud.SDK/OrderCloud.SDK.csproj b/src/OrderCloud.SDK/OrderCloud.SDK.csproj index 1a2f6dd..9cd693e 100644 --- a/src/OrderCloud.SDK/OrderCloud.SDK.csproj +++ b/src/OrderCloud.SDK/OrderCloud.SDK.csproj @@ -4,7 +4,7 @@ netstandard2.0;net461 True - 0.18.7 + 0.18.8 OrderCloud.SDK OrderCloud SDK Todd Menier