From 164061c943abc6eed54ba1777c09b8aabc53087d Mon Sep 17 00:00:00 2001 From: DJ Steinmetz Date: Wed, 16 Jul 2025 14:52:44 -0500 Subject: [PATCH] updates for latest api version --- src/OrderCloud.SDK/Generated/Models.cs | 404 +++++++++++------------ src/OrderCloud.SDK/OrderCloud.SDK.csproj | 2 +- 2 files changed, 203 insertions(+), 203 deletions(-) diff --git a/src/OrderCloud.SDK/Generated/Models.cs b/src/OrderCloud.SDK/Generated/Models.cs index 5c0964e..d3bcefa 100644 --- a/src/OrderCloud.SDK/Generated/Models.cs +++ b/src/OrderCloud.SDK/Generated/Models.cs @@ -67,22 +67,22 @@ public class AddedPromo : OrderCloudModel public string ItemSortBy { get => GetProp("ItemSortBy"); set => SetProp("ItemSortBy", value); } /// Description of the added promo. Max length 2000 characters. Searchable: priority level 4. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// Terms, conditions, and other legal jargon. + /// For reference only. Terms, conditions, and other legal jargon. public string FinePrint { get => GetProp("FinePrint"); set => SetProp("FinePrint", value); } /// Start date of the added promo. Sortable. public DateTimeOffset? StartDate { get => GetProp("StartDate"); set => SetProp("StartDate", value); } /// Expiration date of the added promo. Sortable. public DateTimeOffset? ExpirationDate { get => GetProp("ExpirationDate"); set => SetProp("ExpirationDate", value); } - /// The expression evaluated to determine if an item or order is eligible for a promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details. [Required] public string EligibleExpression { get => GetProp("EligibleExpression"); set => SetProp("EligibleExpression", value); } - /// The expression evaluated to determine the discount amount of an eligible promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details. public string ValueExpression { get => GetProp("ValueExpression"); set => SetProp("ValueExpression", value); } /// If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined. public bool CanCombine { get => GetProp("CanCombine"); set => SetProp("CanCombine", value); } - /// Allow promo to be used by all buyers in your Marketplace without creating explicit assignments. + /// Allow promo to be used by all buyers without creating explicit assignments. public bool AllowAllBuyers { get => GetProp("AllowAllBuyers"); set => SetProp("AllowAllBuyers", value); } - /// ID of the organization that owns the Promotion. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// Auto apply of the added promo. Sortable. public bool AutoApply { get => GetProp("AutoApply", false); set => SetProp("AutoApply", value); } @@ -90,7 +90,7 @@ public class AddedPromo : OrderCloudModel public bool Active { get => GetProp("Active", true); set => SetProp("Active", value); } /// Use integration of the added promo. public bool UseIntegration { get => GetProp("UseIntegration"); set => SetProp("UseIntegration", value); } - /// Used to control the order in which promotions are applied when calling the auto apply endpoint. + /// Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint. public int? Priority { get => GetProp("Priority"); set => SetProp("Priority", value); } /// Container for extended (custom) properties of the added promo. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -177,9 +177,9 @@ public class AdHocProduct : OrderCloudModel public decimal? ShipWidth { get => GetProp("ShipWidth"); set => SetProp("ShipWidth", value); } /// Ship length of the ad hoc product. public decimal? ShipLength { get => GetProp("ShipLength"); set => SetProp("ShipLength", value); } - /// If this property has a value and a SupplierID isn't explicitly passed when creating a LineItem, this SupplierID will be used. + /// Used for forwarding orders to suppliers. public string DefaultSupplierID { get => GetProp("DefaultSupplierID"); set => SetProp("DefaultSupplierID", value); } - /// If true, all suppliers are eligible to opt into selling this product. + /// Returnable of the ad hoc product. public bool Returnable { get => GetProp("Returnable"); set => SetProp("Returnable", value); } /// Container for extended (custom) properties of the ad hoc product. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -192,10 +192,10 @@ public class AdHocProduct : AdHocProduct } public class ApiClient : OrderCloudModel { - /// Used for OAuth 2.0 workflows and OrderCloud impersonation to represent this Client Application. + /// Used for OAuth 2.0 workflows and impersonation. [ApiReadOnly] public string ID { get => GetProp("ID"); set => SetProp("ID", value); } - /// Enables the OAuth 2.0 Client Credentials grant type. Required on all OAuth workflows when present. + /// Enables the OAuth 2.0 client credentials grant type. Required on all OAuth workflows when present. public string ClientSecret { get => GetProp("ClientSecret"); set => SetProp("ClientSecret", value); } /// Access token duration of the api client. Required. Must be between 10 and 600. [Required] @@ -207,19 +207,19 @@ 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. + /// Specifies the duration of anonymous tokens, expressed in minutes. This value is only used if the API Client 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. + /// Optionally define 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. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } - /// Allow all buyer users in your organization access to authenticate using this ApiClient. + /// Allow all buyer users in your organization access to authenticate using this API Client. public bool AllowAnyBuyer { get => GetProp("AllowAnyBuyer"); set => SetProp("AllowAnyBuyer", value); } - /// Allow all supplier users in your organization access to authenticate using this ApiClient. + /// Allow all supplier users in your organization access to authenticate using this API Client. public bool AllowAnySupplier { get => GetProp("AllowAnySupplier"); set => SetProp("AllowAnySupplier", value); } - /// Allow all marketplace owner users in your organization access to authenticate using this ApiClient. + /// Allow all marketplace owner users in your organization access to authenticate using this API Client. public bool AllowSeller { get => GetProp("AllowSeller"); set => SetProp("AllowSeller", value); } - /// Enables anonymous shopping. It only works when a Buyer User is the Default Context User. + /// Enables anonymous shopping when a buyer user is the DefaultContextUser. public bool IsAnonBuyer { get => GetProp("IsAnonBuyer"); set => SetProp("IsAnonBuyer", value); } /// Assigned buyer count of the api client. [ApiReadOnly] @@ -227,17 +227,17 @@ public class ApiClient : OrderCloudModel /// Assigned supplier count of the api client. [ApiReadOnly] public int AssignedSupplierCount { get => GetProp("AssignedSupplierCount"); set => SetProp("AssignedSupplierCount", value); } - /// If populated, an error will be thrown when attempting to submit an order that has not been processed through the OrderCheckout Integration. + /// If populated, an error will be thrown when attempting to submit an order that has not been processed through the OrderCheckout integration. public string OrderCheckoutIntegrationEventID { get => GetProp("OrderCheckoutIntegrationEventID"); set => SetProp("OrderCheckoutIntegrationEventID", value); } /// Order checkout integration event name of the api client. [ApiReadOnly] public string OrderCheckoutIntegrationEventName { get => GetProp("OrderCheckoutIntegrationEventName"); set => SetProp("OrderCheckoutIntegrationEventName", value); } - /// If populated, and not overriden by an OrderAdmin, the integration event will be used to calculate ReturnAmount on the Order Return or each individual return item. + /// If populated, and not overriden by an OrderAdmin, the integration event will be used to calculate ReturnAmount on the order return or each individual return item. public string OrderReturnIntegrationEventID { get => GetProp("OrderReturnIntegrationEventID"); set => SetProp("OrderReturnIntegrationEventID", value); } /// Order return integration event name of the api client. [ApiReadOnly] public string OrderReturnIntegrationEventName { get => GetProp("OrderReturnIntegrationEventName"); set => SetProp("OrderReturnIntegrationEventName", value); } - /// If populated, the integration event will be used to fetch product information from an external system, instead of an OrderCloud catalog, when a line item is added to an unsubmitted order. + /// If populated, the integration event will be used to fetch product information from an external system when a line item is added to an unsubmitted order and the product does not exist in OrderCloud. public string AddToCartIntegrationEventID { get => GetProp("AddToCartIntegrationEventID"); set => SetProp("AddToCartIntegrationEventID", value); } /// Add to cart integration event name of the api client. [ApiReadOnly] @@ -306,7 +306,7 @@ public class ApprovalRule : OrderCloudModel /// ID of the approving group. Required. Sortable. [Required] public string ApprovingGroupID { get => GetProp("ApprovingGroupID"); set => SetProp("ApprovingGroupID", value); } - /// The expression evaluated to determine an order requires approval. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine an order requires approval. See rules engine documentation for formatting details. [Required] public string RuleExpression { get => GetProp("RuleExpression"); set => SetProp("RuleExpression", value); } /// Container for extended (custom) properties of the approval rule. @@ -340,14 +340,14 @@ public class Bundle : OrderCloudModel { /// ID of the bundle. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 3. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } - /// ID of the organization that owns the Bundle. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the bundle. Only the ma marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// Name of the bundle. Required. Max length 100 characters. Searchable: priority level 2. Sortable: priority level 2. [Required] public string Name { get => GetProp("Name"); set => SetProp("Name", value); } /// Description of the bundle. Max length 2000 characters. Searchable: priority level 3. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// If false, bundle is not visible or purchasable from the Shopper perspective. + /// If false, bundle is not visible or purchasable from a buyer's perspective. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } /// Consider keeping bundle and product xp schemas consistent. Defining conflicting xp types will result in indexing problems. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -415,7 +415,7 @@ public class Buyer : OrderCloudModel public string Name { get => GetProp("Name"); set => SetProp("Name", value); } /// If null on POST a new default catalog will be created for the buyer. Used in buyer product queries to allow filtering on categories without explicitly providing a CatalogID. public string DefaultCatalogID { get => GetProp("DefaultCatalogID"); set => SetProp("DefaultCatalogID", value); } - /// If false, all authentication is prohibited. + /// If false, all user authentication is blocked. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } /// Date created of the buyer. Sortable. [ApiReadOnly] @@ -434,11 +434,11 @@ public class BuyerAddress : OrderCloudModel /// ID of the address. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 2. [ApiReadOnly] public string ID { get => GetProp("ID"); set => SetProp("ID", value); } - /// Indicates whether this Address can be used as a Shipping Address on an Order or Line Item. + /// Indicates whether this address can be used as a ShippingAddress on an order or line item. public bool Shipping { get => GetProp("Shipping"); set => SetProp("Shipping", value); } - /// Indicates whether this Address can be used as a Billing Address on an Order. + /// Indicates whether this address can be used as a BillingAddress on an order. public bool Billing { get => GetProp("Billing"); set => SetProp("Billing", value); } - /// Indicates whether this Address can be edited by the current User. + /// Indicates whether this address can be edited by the current user. [ApiReadOnly] public bool Editable { get => GetProp("Editable"); set => SetProp("Editable", value); } /// Date created of the address. Sortable. @@ -539,19 +539,19 @@ public class BuyerProduct : OrderCloudModel public decimal? ShipWidth { get => GetProp("ShipWidth"); set => SetProp("ShipWidth", value); } /// Ship length of the product. public decimal? ShipLength { get => GetProp("ShipLength"); set => SetProp("ShipLength", value); } - /// If false, product is not visible or purchasable from the Shopper perspective. + /// If false, product is not visible or purchasable from a buyer's perspective. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } - /// Count of Specs assigned to the product. + /// Count of specs assigned to the product. [ApiReadOnly] public int SpecCount { get => GetProp("SpecCount"); set => SetProp("SpecCount", value); } - /// Count of Variants generated from the product/spec combinations. + /// Count of variants generated from the product/spec combinations. [ApiReadOnly] public int VariantCount { get => GetProp("VariantCount"); set => SetProp("VariantCount", value); } - /// Marketplace Owner or Supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. + /// Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. public string ShipFromAddressID { get => GetProp("ShipFromAddressID"); set => SetProp("ShipFromAddressID", value); } /// Inventory of the product. public Inventory Inventory { get => GetProp("Inventory"); set => SetProp("Inventory", value); } - /// If this property has a value and a SupplierID isn't explicitly passed when creating a LineItem, this SupplierID will be used. + /// Used for forwarding orders to suppliers. public string DefaultSupplierID { get => GetProp("DefaultSupplierID"); set => SetProp("DefaultSupplierID", value); } /// If true, all suppliers are eligible to opt into selling this product. public bool AllSuppliersCanSell { get => GetProp("AllSuppliersCanSell"); set => SetProp("AllSuppliersCanSell", value); } @@ -585,14 +585,14 @@ public class Catalog : OrderCloudModel { /// ID of the catalog. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 3. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } - /// ID of the organization that owns the Catalog. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the catalog. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// Name of the catalog. Required. Max length 100 characters. Searchable: priority level 2. Sortable: priority level 2. [Required] public string Name { get => GetProp("Name"); set => SetProp("Name", value); } /// Description of the catalog. Max length 2000 characters. Searchable: priority level 3. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// Categories and Products within to this catalog will not be visible to buyer users if false. + /// Categories and products within to this catalog will not be visible to buyer users if false. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } /// Category count of the catalog. [ApiReadOnly] @@ -630,7 +630,7 @@ public class Category : OrderCloudModel public string Description { get => GetProp("Description"); set => SetProp("Description", value); } /// Order that the category appears within its parent or catalog (if root level). public int? ListOrder { get => GetProp("ListOrder"); set => SetProp("ListOrder", value); } - /// If false, buyers cannot see this Category or any Categories or Products under it. + /// If false, buyers cannot see this category or any categories or products under it. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } /// ID of the parent category. public string ParentID { get => GetProp("ParentID"); set => SetProp("ParentID", value); } @@ -656,9 +656,9 @@ public class CategoryAssignment : OrderCloudModel public string BuyerID { get => GetProp("BuyerID"); set => SetProp("BuyerID", value); } /// ID of the user group. public string UserGroupID { get => GetProp("UserGroupID"); set => SetProp("UserGroupID", value); } - /// Optional. Set to null to inherit from parent category or catalog level. + /// Set to null to inherit from parent category or catalog level. public bool? Visible { get => GetProp("Visible"); set => SetProp("Visible", value); } - /// Optional. Set to null to inherit from parent category or catalog level. + /// Set to null to inherit from parent category or catalog level. public bool? ViewAllProducts { get => GetProp("ViewAllProducts"); set => SetProp("ViewAllProducts", value); } } public class CategoryBundleAssignment : OrderCloudModel @@ -806,7 +806,7 @@ public class DeliveryTargets : OrderCloudModel public MandrillConfig Mandrill { get => GetProp("Mandrill"); set => SetProp("Mandrill", value); } /// Message sender of the delivery target. public MessageSenderConfig MessageSender { get => GetProp("MessageSender"); set => SetProp("MessageSender", value); } - /// This feature is in preview and functionality is subject to change. + /// Content hub of the delivery target. public ContentHubConfig ContentHub { get => GetProp("ContentHub"); set => SetProp("ContentHub", value); } } public class DiscoverEvent : OrderCloudModel @@ -851,22 +851,22 @@ public class EligiblePromotion : OrderCloudModel public string ItemSortBy { get => GetProp("ItemSortBy"); set => SetProp("ItemSortBy", value); } /// Description of the eligible promotion. Max length 2000 characters. Searchable: priority level 4. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// Terms, conditions, and other legal jargon. + /// For reference only. Terms, conditions, and other legal jargon. public string FinePrint { get => GetProp("FinePrint"); set => SetProp("FinePrint", value); } /// Start date of the eligible promotion. Sortable. public DateTimeOffset? StartDate { get => GetProp("StartDate"); set => SetProp("StartDate", value); } /// Expiration date of the eligible promotion. Sortable. public DateTimeOffset? ExpirationDate { get => GetProp("ExpirationDate"); set => SetProp("ExpirationDate", value); } - /// The expression evaluated to determine if an item or order is eligible for a promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details. [Required] public string EligibleExpression { get => GetProp("EligibleExpression"); set => SetProp("EligibleExpression", value); } - /// The expression evaluated to determine the discount amount of an eligible promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details. public string ValueExpression { get => GetProp("ValueExpression"); set => SetProp("ValueExpression", value); } /// If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined. public bool CanCombine { get => GetProp("CanCombine"); set => SetProp("CanCombine", value); } - /// Allow promo to be used by all buyers in your Marketplace without creating explicit assignments. + /// Allow promo to be used by all buyers without creating explicit assignments. public bool AllowAllBuyers { get => GetProp("AllowAllBuyers"); set => SetProp("AllowAllBuyers", value); } - /// ID of the organization that owns the Promotion. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// Auto apply of the eligible promotion. Sortable. public bool AutoApply { get => GetProp("AutoApply", false); set => SetProp("AutoApply", value); } @@ -874,7 +874,7 @@ public class EligiblePromotion : OrderCloudModel public bool Active { get => GetProp("Active", true); set => SetProp("Active", value); } /// Use integration of the eligible promotion. public bool UseIntegration { get => GetProp("UseIntegration"); set => SetProp("UseIntegration", value); } - /// Used to control the order in which promotions are applied when calling the auto apply endpoint. + /// Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint. public int? Priority { get => GetProp("Priority"); set => SetProp("Priority", value); } /// Container for extended (custom) properties of the eligible promotion. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -928,10 +928,10 @@ public class ExtendedLineItem : OrderCloudModel public string ProductID { get => GetProp("ProductID"); set => SetProp("ProductID", value); } /// Quantity of the extended line item. Must be at least 1. public int Quantity { get => GetProp("Quantity", 1); set => SetProp("Quantity", value); } - /// The ID of the Line Item that represents the bundle. Signifies that the Product is being purchased as part of a Bundle. + /// The ID of the line item that represents the bundle. Signifies that the product is being purchased as part of a bundle. [ApiReadOnly] public string BundleItemID { get => GetProp("BundleItemID"); set => SetProp("BundleItemID", value); } - /// When true, this item represents a Bundle being purchased. + /// When true, this item represents a bundle being purchased. [ApiReadOnly] public bool IsBundle { get => GetProp("IsBundle"); set => SetProp("IsBundle", value); } /// Date added of the extended line item. Sortable: priority level 1. @@ -940,7 +940,7 @@ public class ExtendedLineItem : OrderCloudModel /// Sum of QuantityShipped from all shipment items. [ApiReadOnly] public int QuantityShipped { get => GetProp("QuantityShipped"); set => SetProp("QuantityShipped", value); } - /// Auto calculated Price per Quantity. Modification requires OverrideUnitPrice Role. + /// Auto calculated price per quantity. Modification requires OverrideUnitPrice role. public decimal? UnitPrice { get => GetProp("UnitPrice"); set => SetProp("UnitPrice", value); } /// Sum of all line item level promotion discount amounts applied. [ApiReadOnly] @@ -959,7 +959,7 @@ public class ExtendedLineItem : OrderCloudModel public string ShippingAccount { get => GetProp("ShippingAccount"); set => SetProp("ShippingAccount", value); } /// ID of the shipping address. public string ShippingAddressID { get => GetProp("ShippingAddressID"); set => SetProp("ShippingAddressID", value); } - /// Marketplace Owner or Supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. + /// Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. public string ShipFromAddressID { get => GetProp("ShipFromAddressID"); set => SetProp("ShipFromAddressID", value); } /// Product of the extended line item. [ApiReadOnly] @@ -976,23 +976,23 @@ public class ExtendedLineItem : OrderCloudModel /// ID of the supplier. [ApiReadOnly] public string SupplierID { get => GetProp("SupplierID"); set => SetProp("SupplierID", value); } - /// Inventory Record ID of which product inventory location to use. The Inventory Record ID cannot be modified once an order is submitted. + /// InventoryRecordID of which product inventory location to use. Cannot be modified once an order is submitted. public string InventoryRecordID { get => GetProp("InventoryRecordID"); set => SetProp("InventoryRecordID", value); } - /// ID of the Price Schedule used to determine Unit price. + /// PriceScheduleID used to determine unit price. [ApiReadOnly] public string PriceScheduleID { get => GetProp("PriceScheduleID"); set => SetProp("PriceScheduleID", value); } /// True when the price schedule and price break has an active SalePrice. [ApiReadOnly] public bool IsOnSale { get => GetProp("IsOnSale"); set => SetProp("IsOnSale", value); } - /// If true, UnitPrice was overwritten. + /// If true, UnitPrice was overridden. [ApiReadOnly] public bool PriceOverridden { get => GetProp("PriceOverridden"); set => SetProp("PriceOverridden", value); } /// Specs of the extended line item. public IList Specs { get => GetProp>("Specs", new List()); set => SetProp>("Specs", value); } - /// ID of the original order. Only returns a value for the Marketplace Owner. + /// ID of the original order. Only returns a value for the marketplace owner. [ApiReadOnly] public string IncomingOrderID { get => GetProp("IncomingOrderID"); set => SetProp("IncomingOrderID", value); } - /// ID of the split or forwarded order. Only returns a value for the Marketplace Owner. + /// ID of the split or forwarded order. Only returns a value for the marketplace owner. [ApiReadOnly] public string OutgoingOrderID { get => GetProp("OutgoingOrderID"); set => SetProp("OutgoingOrderID", value); } /// Features in beta are subject to change and are not available in production. ID of the invitation. @@ -1040,9 +1040,9 @@ public class ExtendedOrder : OrderCloudModel /// User placing the order. [ApiReadOnly] public User FromUser { get => GetProp("FromUser"); set => SetProp("FromUser", value); } - /// ID of the Buyer or Marketplace Owner placing the order. Mainly useful to the Marketplace Owner or Supplier receiving it. + /// ID of the Buyer placing the order, or the marketplace owner when an order is being forwarded. Mainly useful to the marketplace owner or supplier receiving it. public string FromCompanyID { get => GetProp("FromCompanyID"); set => SetProp("FromCompanyID", value); } - /// ID of the Marketplace Owner or Supplier receiving the order, only writable on create. Mainly useful to the user placing it. + /// ID of the marketplace owner or supplier receiving the order, only writable on create. Mainly useful to the user placing it. public string ToCompanyID { get => GetProp("ToCompanyID"); set => SetProp("ToCompanyID", value); } /// This property is only writable when creating an order on behalf of a buyer user. public string FromUserID { get => GetProp("FromUserID"); set => SetProp("FromUserID", value); } @@ -1051,7 +1051,7 @@ public class ExtendedOrder : OrderCloudModel /// Billing address of the extended order. [ApiReadOnly] public Address BillingAddress { get => GetProp
("BillingAddress"); set => SetProp
("BillingAddress", value); } - /// ID of the Shipping Address for all LineItems on the Order. Null when there are multiple Shipping Addresses involved. + /// ID of the ShippingAddress for all line items on the order. Null when there are multiple shipping addresses defined. public string ShippingAddressID { get => GetProp("ShippingAddressID"); set => SetProp("ShippingAddressID", value); } /// Comments of the extended order. Max length 2000 characters. Searchable: priority level 4. public string Comments { get => GetProp("Comments"); set => SetProp("Comments", value); } @@ -1064,7 +1064,7 @@ public class ExtendedOrder : OrderCloudModel /// Date created of the extended order. Sortable: priority level 2. [ApiReadOnly] public DateTimeOffset? DateCreated { get => GetProp("DateCreated"); set => SetProp("DateCreated", value); } - /// NULL until the order passes from the buyer to the Marketplace Owner, including when Status is PendingApproval. + /// Null until the order passes from the buyer to the marketplace owner, including when Status is PendingApproval. [ApiReadOnly] public DateTimeOffset? DateSubmitted { get => GetProp("DateSubmitted"); set => SetProp("DateSubmitted", value); } /// Date approved of the extended order. Sortable. @@ -1085,16 +1085,16 @@ public class ExtendedOrder : OrderCloudModel /// Sum of all LineItem.LineSubtotals. [ApiReadOnly] public decimal Subtotal { get => GetProp("Subtotal"); set => SetProp("Subtotal", value); } - /// Modifying requires OverrideShipping Role. + /// Modifying requires OverrideShipping role. public decimal ShippingCost { get => GetProp("ShippingCost"); set => SetProp("ShippingCost", value); } - /// Modifying requires TaxOverride Role. + /// Modifying requires TaxOverride role. public decimal TaxCost { get => GetProp("TaxCost"); set => SetProp("TaxCost", value); } /// Gratuity of the extended order. Must be at least 0. Sortable. public decimal Gratuity { get => GetProp("Gratuity", 0); set => SetProp("Gratuity", value); } /// Fees associated with order or line items [ApiReadOnly] public decimal Fees { get => GetProp("Fees", 0); set => SetProp("Fees", value); } - /// Sum of all Promotion.Amounts applied to the order. + /// Sum of all promotion amounts applied to the order. [ApiReadOnly] public decimal PromotionDiscount { get => GetProp("PromotionDiscount"); set => SetProp("PromotionDiscount", value); } /// Inherited from the user placing the order. @@ -1103,7 +1103,7 @@ public class ExtendedOrder : OrderCloudModel /// Subtotal + TaxCost + ShippingCost + Gratuity + Fees - PromotionDiscount [ApiReadOnly] public decimal Total { get => GetProp("Total"); set => SetProp("Total", value); } - /// True if this Order has been passed from the Buyer to the Marketplace Owner. + /// True if this order has been passed from the Buyer to the marketplace owner or supplier. [ApiReadOnly] public bool IsSubmitted { get => GetProp("IsSubmitted"); set => SetProp("IsSubmitted", value); } /// ID of the subscription used to create an order in an automated process. @@ -1138,7 +1138,7 @@ public class GroupOrderInvitation : OrderCloudModel /// ID of the group order invitation. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 1. [ApiReadOnly] public string ID { get => GetProp("ID"); set => SetProp("ID", value); } - /// maximum 1 year. + /// Maximum 1 year. [Required] public DateTimeOffset? ExpirationDate { get => GetProp("ExpirationDate"); set => SetProp("ExpirationDate", value); } /// Name of the group order invitation. Max length 100 characters. Searchable: priority level 2. Sortable: priority level 2. @@ -1189,13 +1189,13 @@ public class ImpersonationConfig : OrderCloudModel { /// ID of the impersonation config. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 8. Sortable: priority level 8. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } - /// The Buyer ID of the impersonator group or user (party doing the impersonating) + /// The BuyerID of the impersonator group or user (party doing the impersonating) public string ImpersonationBuyerID { get => GetProp("ImpersonationBuyerID"); set => SetProp("ImpersonationBuyerID", value); } /// The UserGroupID of the impersonator (party doing the impersonating) public string ImpersonationGroupID { get => GetProp("ImpersonationGroupID"); set => SetProp("ImpersonationGroupID", value); } /// The UserID of the impersonator (party doing the impersonating) public string ImpersonationUserID { get => GetProp("ImpersonationUserID"); set => SetProp("ImpersonationUserID", value); } - /// The BuyerID of the impersonatee (party being impersonated). If null, the config can be used to impersonate users in any buyer in the marketplace that is able to access the specified ClientID. + /// The BuyerID of the impersonatee (party being impersonated). If null, the config can be used to impersonate users in any buyer in the marketplace that is able to access the specified API Client. public string BuyerID { get => GetProp("BuyerID"); set => SetProp("BuyerID", value); } /// The UserGroupID of the impersonatee (party being impersonated) public string GroupID { get => GetProp("GroupID"); set => SetProp("GroupID", value); } @@ -1227,11 +1227,11 @@ public class IntegrationEvent : OrderCloudModel public IList ElevatedRoles { get => GetProp>("ElevatedRoles", new List()); set => SetProp>("ElevatedRoles", value); } /// ID of the integration event. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 1. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } - /// Any additional data needed for your Integration Event should be included here. + /// Any additional data needed for your integration event should be included here. public object ConfigData { get => GetProp("ConfigData"); set => SetProp("ConfigData", value); } /// Event type of the integration event. Searchable: priority level 2. Sortable: priority level 2. Possible values: OrderCheckout, OpenIDConnect, OrderReturn, AddToCart. public IntegrationEventType EventType { get => GetProp("EventType"); set => SetProp("EventType", value); } - /// URL the IntegrationEvent will POST data to, likely a route within your middleware. + /// URL the integration event will POST data to, likely a route within your middleware. [Required] public string CustomImplementationUrl { get => GetProp("CustomImplementationUrl"); set => SetProp("CustomImplementationUrl", value); } /// The header name that can be passed to your middleware. @@ -1252,11 +1252,11 @@ public class Inventory : OrderCloudModel public bool Enabled { get => GetProp("Enabled"); set => SetProp("Enabled", value); } /// Notification point of the inventory. public int? NotificationPoint { get => GetProp("NotificationPoint"); set => SetProp("NotificationPoint", value); } - /// If true, QuantityAvailable will be determined at the Variant level. + /// If true, QuantityAvailable will be determined at the variant level. public bool VariantLevelTracking { get => GetProp("VariantLevelTracking"); set => SetProp("VariantLevelTracking", value); } /// If true, a user can create line items and place orders for the product even if there is insufficient QuantityAvailable. public bool OrderCanExceed { get => GetProp("OrderCanExceed"); set => SetProp("OrderCanExceed", value); } - /// Automatically decrements on order submit. If you utilize InventoryRecords either at the product or variant level, this property becomes readonly, and is derived from the sum of all QuantityAvailable of each InventoryRecord. If VariantLevelTracking is enabled, this is the sum of all variant quantities, so the value may not be very useful beyond using it to filter out products with no variant level inventory available. + /// Automatically decrements on order submit. If you utilize inventory records either at the product or variant level, this property becomes readonly, and is derived from the sum of all QuantityAvailable of each InventoryRecord. If VariantLevelTracking is enabled, this is the sum of all variant quantities. public int? QuantityAvailable { get => GetProp("QuantityAvailable"); set => SetProp("QuantityAvailable", value); } /// Last updated of the inventory. [ApiReadOnly] @@ -1276,12 +1276,12 @@ 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. + /// Allow inventory record to be used by all buyers without creating explicit assignments. public bool AllowAllBuyers { get => GetProp("AllowAllBuyers", true); set => SetProp("AllowAllBuyers", value); } /// Address of the inventory record. [ApiReadOnly] public Address Address { get => GetProp
("Address"); set => SetProp
("Address", value); } - /// Since an InventoryRecord represents a physical location where inventory for a given product exists, AddressID is required. + /// AddressID is required because an inventory record represents a location where physical inventory for a given product exists. [Required] public string AddressID { get => GetProp("AddressID"); set => SetProp("AddressID", value); } /// Order can exceed of the inventory record. @@ -1343,10 +1343,10 @@ public class LineItem : OrderCloudModel public string ProductID { get => GetProp("ProductID"); set => SetProp("ProductID", value); } /// Quantity of the line item. Must be at least 1. public int Quantity { get => GetProp("Quantity", 1); set => SetProp("Quantity", value); } - /// The ID of the Line Item that represents the bundle. Signifies that the Product is being purchased as part of a Bundle. + /// The ID of the line item that represents the bundle. Signifies that the product is being purchased as part of a bundle. [ApiReadOnly] public string BundleItemID { get => GetProp("BundleItemID"); set => SetProp("BundleItemID", value); } - /// When true, this item represents a Bundle being purchased. + /// When true, this item represents a bundle being purchased. [ApiReadOnly] public bool IsBundle { get => GetProp("IsBundle"); set => SetProp("IsBundle", value); } /// Date added of the line item. Sortable: priority level 1. @@ -1355,7 +1355,7 @@ public class LineItem : OrderCloudModel /// Sum of QuantityShipped from all shipment items. [ApiReadOnly] public int QuantityShipped { get => GetProp("QuantityShipped"); set => SetProp("QuantityShipped", value); } - /// Auto calculated Price per Quantity. Modification requires OverrideUnitPrice Role. + /// Auto calculated price per quantity. Modification requires OverrideUnitPrice role. public decimal? UnitPrice { get => GetProp("UnitPrice"); set => SetProp("UnitPrice", value); } /// Sum of all line item level promotion discount amounts applied. [ApiReadOnly] @@ -1374,7 +1374,7 @@ public class LineItem : OrderCloudModel public string ShippingAccount { get => GetProp("ShippingAccount"); set => SetProp("ShippingAccount", value); } /// ID of the shipping address. public string ShippingAddressID { get => GetProp("ShippingAddressID"); set => SetProp("ShippingAddressID", value); } - /// Marketplace Owner or Supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. + /// Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. public string ShipFromAddressID { get => GetProp("ShipFromAddressID"); set => SetProp("ShipFromAddressID", value); } /// Product of the line item. [ApiReadOnly] @@ -1391,23 +1391,23 @@ public class LineItem : OrderCloudModel /// ID of the supplier. [ApiReadOnly] public string SupplierID { get => GetProp("SupplierID"); set => SetProp("SupplierID", value); } - /// Inventory Record ID of which product inventory location to use. The Inventory Record ID cannot be modified once an order is submitted. + /// InventoryRecordID of which product inventory location to use. Cannot be modified once an order is submitted. public string InventoryRecordID { get => GetProp("InventoryRecordID"); set => SetProp("InventoryRecordID", value); } - /// ID of the Price Schedule used to determine Unit price. + /// PriceScheduleID used to determine unit price. [ApiReadOnly] public string PriceScheduleID { get => GetProp("PriceScheduleID"); set => SetProp("PriceScheduleID", value); } /// True when the price schedule and price break has an active SalePrice. [ApiReadOnly] public bool IsOnSale { get => GetProp("IsOnSale"); set => SetProp("IsOnSale", value); } - /// If true, UnitPrice was overwritten. + /// If true, UnitPrice was overridden. [ApiReadOnly] public bool PriceOverridden { get => GetProp("PriceOverridden"); set => SetProp("PriceOverridden", value); } /// Specs of the line item. public IList Specs { get => GetProp>("Specs", new List()); set => SetProp>("Specs", value); } - /// ID of the original order. Only returns a value for the Marketplace Owner. + /// ID of the original order. Only returns a value for the marketplace owner. [ApiReadOnly] public string IncomingOrderID { get => GetProp("IncomingOrderID"); set => SetProp("IncomingOrderID", value); } - /// ID of the split or forwarded order. Only returns a value for the Marketplace Owner. + /// ID of the split or forwarded order. Only returns a value for the marketplace owner. [ApiReadOnly] public string OutgoingOrderID { get => GetProp("OutgoingOrderID"); set => SetProp("OutgoingOrderID", value); } /// Features in beta are subject to change and are not available in production. ID of the invitation. @@ -1543,12 +1543,12 @@ public class Locale : OrderCloudModel { /// ID of the locale. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 1. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } - /// ID of the organization that owns the Locale. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the Locale. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } - /// We recommend using ISO-4217 Currency Codes for compatibility with tax and payment processors. + /// We recommend using ISO-4217 currency codes for compatibility with tax and payment processors. [Required] public string Currency { get => GetProp("Currency"); set => SetProp("Currency", value); } - /// We recommend using ISO-639 Language code - ISO-3166 Country code (e.g. en-US). + /// We recommend using ISO-639 language code - ISO-3166 Country code (e.g. en-US). public string Language { get => GetProp("Language"); set => SetProp("Language", value); } } public class LocaleAssignment : OrderCloudModel @@ -1619,7 +1619,7 @@ public class MessageSender : OrderCloudModel public IList MessageTypes { get => GetProp>("MessageTypes", new List()); set => SetProp>("MessageTypes", value); } /// Description of the message sender. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// URL the MessageSender will POST data to, likely a route within your middleware. + /// URL the message sender will POST data to, likely a route within your middleware. public string URL { get => GetProp("URL"); set => SetProp("URL", value); } /// If additional data not provided by the message sender is needed, provide any elevated roles needed to make additional calls. public IList ElevatedRoles { get => GetProp>("ElevatedRoles", new List()); set => SetProp>("ElevatedRoles", value); } @@ -1629,7 +1629,7 @@ 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. + /// Allow message sender to trigger for all buyers 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. @@ -1688,7 +1688,7 @@ public class MeUser : OrderCloudModel /// ID of the company. [ApiReadOnly] public string CompanyID { get => GetProp("CompanyID"); set => SetProp("CompanyID", value); } - /// Must be unique across the Marketplace. + /// Must be unique across all organizations. [Required] public string Username { get => GetProp("Username"); set => SetProp("Username", value); } /// Password of the user. @@ -1712,10 +1712,10 @@ public class MeUser : OrderCloudModel public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } /// Container for extended (custom) properties of the user. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } - /// List of Roles currently available to the user via all SecurityProfile Assignments. + /// List of roles currently available to the user via all security profile assignments. [ApiReadOnly] public IReadOnlyList AvailableRoles { get => GetProp>("AvailableRoles"); set => SetProp>("AvailableRoles", value); } - /// Most specific Locale assigned to the user, if any. + /// Most specific locale assigned to the user, if any. [ApiReadOnly] public Locale Locale { get => GetProp("Locale"); set => SetProp("Locale", value); } /// Date created of the user. Sortable. @@ -1746,9 +1746,9 @@ public class OneTimePasswordRequest : OrderCloudModel } public class OpenIdConnect : OrderCloudModel { - /// ID of this OpenID Connect configuration object. Each object allows authentication to one OrderCloud ApiClient through one Identity Providing Party. + /// ID of this OpenID Connect configuration object. Each object allows authentication to one OrderCloud API Client through one Identity Providing Party. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } - /// An ID that references an OrderCloud ApiClient. + /// An ID that references an OrderCloud API Client. [Required] public string OrderCloudApiClientID { get => GetProp("OrderCloudApiClientID"); set => SetProp("OrderCloudApiClientID", value); } /// An app ID from the Identity Provider that is required to get JWT tokens. @@ -1768,7 +1768,7 @@ public class OpenIdConnect : OrderCloudModel public string TokenEndpoint { get => GetProp("TokenEndpoint"); set => SetProp("TokenEndpoint", value); } /// If true, uses a url encoded form post with all auth values. Otherwise, an Authorization header with basic auth is passed with a JSON object in the body. public bool UrlEncoded { get => GetProp("UrlEncoded"); set => SetProp("UrlEncoded", value); } - /// ID of the IntegrationEvent to call upon authorization request. Used when you haven't pre-populated users into OrderCloud, or need to sync user data. + /// ID of the integration event to call upon authorization request. Used when you haven't pre-populated users into OrderCloud, or need to sync user data. public string IntegrationEventID { get => GetProp("IntegrationEventID"); set => SetProp("IntegrationEventID", value); } /// If true, the integration event is always triggered regardless of if the user already exists in OrderCloud. public bool CallSyncUserIntegrationEvent { get => GetProp("CallSyncUserIntegrationEvent"); set => SetProp("CallSyncUserIntegrationEvent", value); } @@ -1787,9 +1787,9 @@ public class Order : OrderCloudModel /// User placing the order. [ApiReadOnly] public User FromUser { get => GetProp("FromUser"); set => SetProp("FromUser", value); } - /// ID of the Buyer or Marketplace Owner placing the order. Mainly useful to the Marketplace Owner or Supplier receiving it. + /// ID of the Buyer placing the order, or the marketplace owner when an order is being forwarded. Mainly useful to the marketplace owner or supplier receiving it. public string FromCompanyID { get => GetProp("FromCompanyID"); set => SetProp("FromCompanyID", value); } - /// ID of the Marketplace Owner or Supplier receiving the order, only writable on create. Mainly useful to the user placing it. + /// ID of the marketplace owner or supplier receiving the order, only writable on create. Mainly useful to the user placing it. public string ToCompanyID { get => GetProp("ToCompanyID"); set => SetProp("ToCompanyID", value); } /// This property is only writable when creating an order on behalf of a buyer user. public string FromUserID { get => GetProp("FromUserID"); set => SetProp("FromUserID", value); } @@ -1798,7 +1798,7 @@ public class Order : OrderCloudModel /// Billing address of the order. [ApiReadOnly] public Address BillingAddress { get => GetProp
("BillingAddress"); set => SetProp
("BillingAddress", value); } - /// ID of the Shipping Address for all LineItems on the Order. Null when there are multiple Shipping Addresses involved. + /// ID of the ShippingAddress for all line items on the order. Null when there are multiple shipping addresses defined. public string ShippingAddressID { get => GetProp("ShippingAddressID"); set => SetProp("ShippingAddressID", value); } /// Comments of the order. Max length 2000 characters. Searchable: priority level 4. public string Comments { get => GetProp("Comments"); set => SetProp("Comments", value); } @@ -1811,7 +1811,7 @@ public class Order : OrderCloudModel /// Date created of the order. Sortable: priority level 2. [ApiReadOnly] public DateTimeOffset? DateCreated { get => GetProp("DateCreated"); set => SetProp("DateCreated", value); } - /// NULL until the order passes from the buyer to the Marketplace Owner, including when Status is PendingApproval. + /// Null until the order passes from the buyer to the marketplace owner, including when Status is PendingApproval. [ApiReadOnly] public DateTimeOffset? DateSubmitted { get => GetProp("DateSubmitted"); set => SetProp("DateSubmitted", value); } /// Date approved of the order. Sortable. @@ -1832,16 +1832,16 @@ public class Order : OrderCloudModel /// Sum of all LineItem.LineSubtotals. [ApiReadOnly] public decimal Subtotal { get => GetProp("Subtotal"); set => SetProp("Subtotal", value); } - /// Modifying requires OverrideShipping Role. + /// Modifying requires OverrideShipping role. public decimal ShippingCost { get => GetProp("ShippingCost"); set => SetProp("ShippingCost", value); } - /// Modifying requires TaxOverride Role. + /// Modifying requires TaxOverride role. public decimal TaxCost { get => GetProp("TaxCost"); set => SetProp("TaxCost", value); } /// Gratuity of the order. Must be at least 0. Sortable. public decimal Gratuity { get => GetProp("Gratuity", 0); set => SetProp("Gratuity", value); } /// Fees associated with order or line items [ApiReadOnly] public decimal Fees { get => GetProp("Fees", 0); set => SetProp("Fees", value); } - /// Sum of all Promotion.Amounts applied to the order. + /// Sum of all promotion amounts applied to the order. [ApiReadOnly] public decimal PromotionDiscount { get => GetProp("PromotionDiscount"); set => SetProp("PromotionDiscount", value); } /// Inherited from the user placing the order. @@ -1850,7 +1850,7 @@ public class Order : OrderCloudModel /// Subtotal + TaxCost + ShippingCost + Gratuity + Fees - PromotionDiscount [ApiReadOnly] public decimal Total { get => GetProp("Total"); set => SetProp("Total", value); } - /// True if this Order has been passed from the Buyer to the Marketplace Owner. + /// True if this order has been passed from the Buyer to the marketplace owner or supplier. [ApiReadOnly] public bool IsSubmitted { get => GetProp("IsSubmitted"); set => SetProp("IsSubmitted", value); } /// ID of the subscription used to create an order in an automated process. @@ -1912,7 +1912,7 @@ public class OrderApproval : OrderApproval } public class OrderApprovalInfo : OrderCloudModel { - /// Only relevant when declining an order. Changes the Order Status back to Unsubmitted and allows the user to make changes and resubmit. + /// Only relevant when declining an order. Changes the order Status back to Unsubmitted and allows the user to make changes and resubmit. public bool AllowResubmit { get => GetProp("AllowResubmit"); set => SetProp("AllowResubmit", value); } /// Comments to be saved with the order approval or denial. public string Comments { get => GetProp("Comments"); set => SetProp("Comments", value); } @@ -2001,22 +2001,22 @@ public class OrderPromotion : OrderCloudModel public string ItemSortBy { get => GetProp("ItemSortBy"); set => SetProp("ItemSortBy", value); } /// Description of the order promotion. Max length 2000 characters. Searchable: priority level 4. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// Terms, conditions, and other legal jargon. + /// For reference only. Terms, conditions, and other legal jargon. public string FinePrint { get => GetProp("FinePrint"); set => SetProp("FinePrint", value); } /// Start date of the order promotion. Sortable. public DateTimeOffset? StartDate { get => GetProp("StartDate"); set => SetProp("StartDate", value); } /// Expiration date of the order promotion. Sortable. public DateTimeOffset? ExpirationDate { get => GetProp("ExpirationDate"); set => SetProp("ExpirationDate", value); } - /// The expression evaluated to determine if an item or order is eligible for a promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details. [Required] public string EligibleExpression { get => GetProp("EligibleExpression"); set => SetProp("EligibleExpression", value); } - /// The expression evaluated to determine the discount amount of an eligible promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details. public string ValueExpression { get => GetProp("ValueExpression"); set => SetProp("ValueExpression", value); } /// If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined. public bool CanCombine { get => GetProp("CanCombine"); set => SetProp("CanCombine", value); } - /// Allow promo to be used by all buyers in your Marketplace without creating explicit assignments. + /// Allow promo to be used by all buyers without creating explicit assignments. public bool AllowAllBuyers { get => GetProp("AllowAllBuyers"); set => SetProp("AllowAllBuyers", value); } - /// ID of the organization that owns the Promotion. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// Auto apply of the order promotion. Sortable. public bool AutoApply { get => GetProp("AutoApply", false); set => SetProp("AutoApply", value); } @@ -2024,7 +2024,7 @@ public class OrderPromotion : OrderCloudModel public bool Active { get => GetProp("Active", true); set => SetProp("Active", value); } /// Use integration of the order promotion. public bool UseIntegration { get => GetProp("UseIntegration"); set => SetProp("UseIntegration", value); } - /// Used to control the order in which promotions are applied when calling the auto apply endpoint. + /// Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint. public int? Priority { get => GetProp("Priority"); set => SetProp("Priority", value); } /// Container for extended (custom) properties of the order promotion. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -2042,7 +2042,7 @@ public class OrderReturn : OrderCloudModel /// ID of the order. Required. Searchable: priority level 2. Sortable: priority level 4. [Required] public string OrderID { get => GetProp("OrderID"); set => SetProp("OrderID", value); } - /// IDs of Payments associated with this OrderReturn. + /// IDs of payments associated with this order return. [ApiReadOnly] public IReadOnlyList PaymentIDs { get => GetProp>("PaymentIDs"); set => SetProp>("PaymentIDs", value); } /// Status of the order return. Possible values: Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled. @@ -2051,7 +2051,7 @@ public class OrderReturn : OrderCloudModel /// Date created of the order return. Sortable: priority level 2. [ApiReadOnly] public DateTimeOffset? DateCreated { get => GetProp("DateCreated"); set => SetProp("DateCreated", value); } - /// NULL until the order return passes from the buyer to the Marketplace Owner, including when Status is PendingApproval. + /// Will be null until the order return passes from the buyer to the seller, including when Status is PendingApproval. [ApiReadOnly] public DateTimeOffset? DateSubmitted { get => GetProp("DateSubmitted"); set => SetProp("DateSubmitted", value); } /// Date approved of the order return. Sortable. @@ -2069,7 +2069,7 @@ public class OrderReturn : OrderCloudModel /// Last updated of the order return. Sortable. [ApiReadOnly] public DateTimeOffset LastUpdated { get => GetProp("LastUpdated"); set => SetProp("LastUpdated", value); } - /// Sum of all RefundAmounts for Items. This value can be overridden by a user with the OrderAdmin role. To remove the override set the value to null. + /// Sum of all RefundAmounts for items. This value can be overridden by a user with the OrderAdmin role. To remove the override set the value to null. public decimal? RefundAmount { get => GetProp("RefundAmount"); set => SetProp("RefundAmount", value); } /// Comments of the order return. Max length 2000 characters. public string Comments { get => GetProp("Comments"); set => SetProp("Comments", value); } @@ -2137,16 +2137,16 @@ public class OrderShipMethodSelection : OrderCloudModel } public class OrderSplitResult : OrderCloudModel { - /// The outgoing Orders created, one for each unique Product.DefaultSupplierID on the original Order. + /// The outgoing orders created, one for each unique Product.DefaultSupplierID on the original order. public IList OutgoingOrders { get => GetProp>("OutgoingOrders", new List()); set => SetProp>("OutgoingOrders", value); } - /// IDs of Line Items not added to an outgoing Order, most likely because Product.DefaultSupplierID is not set. + /// IDs of line items not added to an outgoing order, most likely because Product.DefaultSupplierID is not set. public IList RemainingLineItemIDs { get => GetProp>("RemainingLineItemIDs", new List()); set => SetProp>("RemainingLineItemIDs", value); } } /// Specific type of the OutgoingOrders property. If not using a custom type, use the non-generic OrderSplitResult class instead. public class OrderSplitResult : OrderSplitResult where TOutgoingOrders : Order { - /// The outgoing Orders created, one for each unique Product.DefaultSupplierID on the original Order. + /// The outgoing orders created, one for each unique Product.DefaultSupplierID on the original order. public new IList OutgoingOrders { get => GetProp>("OutgoingOrders", new List()); set => SetProp>("OutgoingOrders", value); } } public class OrderSubmitForApprovalResponse : OrderCloudModel @@ -2267,9 +2267,9 @@ public class PasswordConfig : OrderCloudModel public int? MaximumPasswordAge { get => GetProp("MaximumPasswordAge"); set => SetProp("MaximumPasswordAge", value); } /// The password may not be changed again until this number of minutes has passed. public int? MinimumPasswordAge { get => GetProp("MinimumPasswordAge"); set => SetProp("MinimumPasswordAge", value); } - /// The number of failed attempts before the account is Locked for the LockoutDuration. + /// The number of failed attempts before the account is locked for the LockoutDuration. public int? AllowedFailedAttempts { get => GetProp("AllowedFailedAttempts"); set => SetProp("AllowedFailedAttempts", value); } - /// The number of minutes an account is locked when the AllowedFailedAttempts is reached. Use 0 to indicate that lockout should be indefinite (i.e. require the intervention of a user admininstrator). + /// The number of minutes an account is locked when the AllowedFailedAttempts is reached. Use 0 to indicate that lockout should be indefinite, requiring the manual intervention by an admin user. public int? LockoutDuration { get => GetProp("LockoutDuration"); set => SetProp("LockoutDuration", value); } /// At least one upper case character is required. public bool UpperCaseRequired { get => GetProp("UpperCaseRequired"); set => SetProp("UpperCaseRequired", value); } @@ -2314,20 +2314,20 @@ public class Payment : OrderCloudModel /// Date created of the payment. Sortable: priority level 1. [ApiReadOnly] public DateTimeOffset DateCreated { get => GetProp("DateCreated"); set => SetProp("DateCreated", value); } - /// Only writeable on POST. + /// Only writeable on create. public string CreditCardID { get => GetProp("CreditCardID"); set => SetProp("CreditCardID", value); } - /// Only writeable on POST. + /// Only writeable on create. public string SpendingAccountID { get => GetProp("SpendingAccountID"); set => SetProp("SpendingAccountID", value); } /// Description of the payment. Max length 2000 characters. Searchable: priority level 2. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// Inherited from Order. + /// Inherited from order. [ApiReadOnly] public string Currency { get => GetProp("Currency"); set => SetProp("Currency", value); } - /// If null, Payment applies to order total (or total of specific Line Items, if set), minus any other Payments where Amount is set. Value can only be negative if processing a payment for an OrderReturn. + /// If null, payment applies to order total (or total of specific line items, if set), less any other payments where Amount is set. Value can only be negative if processing a payment for an order return. public decimal? Amount { get => GetProp("Amount"); set => SetProp("Amount", value); } /// All payments must be Accepted to submit an order. This property should be updated after authorizing or capturing the payment in your middleware by a user with the elevated OrderAdmin role. public bool? Accepted { get => GetProp("Accepted"); set => SetProp("Accepted", value); } - /// Used to indicate this payment is associated with an Order Return. + /// Used to indicate this payment is associated with an order return. public string OrderReturnID { get => GetProp("OrderReturnID"); set => SetProp("OrderReturnID", value); } /// Container for extended (custom) properties of the payment. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -2356,9 +2356,9 @@ public class PaymentTransaction : OrderCloudModel /// Date executed of the payment transaction. Required. Sortable: priority level 1. [Required] public DateTimeOffset DateExecuted { get => GetProp("DateExecuted"); set => SetProp("DateExecuted", value); } - /// Usually the same as Payment Currency, but can be different. A marketplace may capture funds from the buyer user in one currency and process a payout to the seller in another. + /// Usually the same as Payment.Currency, but can be different. A marketplace owner may capture funds from the buyer user in one currency and process a payout to the seller in another. public string Currency { get => GetProp("Currency"); set => SetProp("Currency", value); } - /// Usually the same as Payment Amount, but can be different. A charge might have a subsequent partial credit, for example. + /// Usually the same as Payment.Amount, but can be different. A charge might have a subsequent partial credit, for example. public decimal? Amount { get => GetProp("Amount"); set => SetProp("Amount", value); } /// Succeeded of the payment transaction. Sortable. public bool Succeeded { get => GetProp("Succeeded"); set => SetProp("Succeeded", value); } @@ -2383,16 +2383,16 @@ public class PriceBreak : OrderCloudModel /// Price per unit. [Required] public decimal Price { get => GetProp("Price"); set => SetProp("Price", value); } - /// Optional. Sale Price per unit. If the current date/time is within the PriceSchedule SaleStart and SaleEnd, this SalePrice will be used. + /// Sale Price per unit. If the current date/time is within the PriceSchedule SaleStart and SaleEnd, this SalePrice will be used. public decimal? SalePrice { get => GetProp("SalePrice"); set => SetProp("SalePrice", value); } - /// Optional. Subscription Price per unit. If set, this price is used when a subscription order is created. + /// Subscription Price per unit. If set, this price is used when a subscription order is created. public decimal? SubscriptionPrice { get => GetProp("SubscriptionPrice"); set => SetProp("SubscriptionPrice", value); } - /// Optional. Bundle Price per unit. If set, this price is used when an item being added to an order is part of a bundle. + /// Bundle Price per unit. If set, this price is used when an item being added to an order is part of a bundle. public decimal? BundlePrice { get => GetProp("BundlePrice"); set => SetProp("BundlePrice", value); } } public class PriceSchedule : OrderCloudModel { - /// ID of the organization that owns the PriceSchedule. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the PriceSchedule. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// ID of the price schedule. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 2. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } @@ -2403,23 +2403,23 @@ public class PriceSchedule : OrderCloudModel public bool ApplyTax { get => GetProp("ApplyTax"); set => SetProp("ApplyTax", value); } /// For reference only for calculating shipping cost, does not influence any OrderCloud behavior. public bool ApplyShipping { get => GetProp("ApplyShipping"); set => SetProp("ApplyShipping", value); } - /// The minimum LineItem Quantity when UseCumulativeQuantity is false. + /// The minimum line item Quantity when UseCumulativeQuantity is false. public int? MinQuantity { get => GetProp("MinQuantity", 1); set => SetProp("MinQuantity", value); } - /// The maximum LineItem Quantity when UseCumulativeQuantity is false. + /// The maximum line item Quantity when UseCumulativeQuantity is false. public int? MaxQuantity { get => GetProp("MaxQuantity"); set => SetProp("MaxQuantity", value); } - /// If true, LineItem quantities will be aggregated by productID when determining which price break applies, and when Min/Max quantities are met. Else, each LineItem is treated separately. + /// If true, line item quantities will be aggregated by productID when determining which price break applies, and when Min/Max quantities are met. Else, each line item is treated separately. public bool UseCumulativeQuantity { get => GetProp("UseCumulativeQuantity"); set => SetProp("UseCumulativeQuantity", value); } /// If true, this product can only be ordered in quantities that exactly match one of the price breaks on this schedule. public bool RestrictedQuantity { get => GetProp("RestrictedQuantity"); set => SetProp("RestrictedQuantity", value); } /// Price breaks of the price schedule. public IList PriceBreaks { get => GetProp>("PriceBreaks", new List()); set => SetProp>("PriceBreaks", value); } - /// We recommend using ISO-4217 Currency Codes for compatibility with tax and payment processors. + /// We recommend using ISO-4217 currency codes for compatibility with tax and payment processors. public string Currency { get => GetProp("Currency"); set => SetProp("Currency", value); } - /// Optional. Starting date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set. + /// Starting date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set. public DateTimeOffset? SaleStart { get => GetProp("SaleStart", null); set => SetProp("SaleStart", value); } - /// Optional. Ending date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set. + /// Ending date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set. public DateTimeOffset? SaleEnd { get => GetProp("SaleEnd", null); set => SetProp("SaleEnd", value); } - /// True when at least one PriceBreak has a SalePrice defined, and it falls between the SaleStart and SaleEnd date, if applicable. + /// True when at least one PriceBreak has a SalePrice defined, and the current time is between the SaleStart and SaleEnd date. [ApiReadOnly] public bool IsOnSale { get => GetProp("IsOnSale"); set => SetProp("IsOnSale", value); } /// Container for extended (custom) properties of the price schedule. @@ -2433,11 +2433,11 @@ public class PriceSchedule : PriceSchedule } public class Product : OrderCloudModel { - /// ID of the organization that owns the Product. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the product. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } - /// When provided, no explicit PriceSchedule assignment is required. When a PriceSchedule assignment exists, it will override any default provided. + /// When provided, no explicit price schedule assignment is required. When a price schedule assignment exists, it will override any default provided. public string DefaultPriceScheduleID { get => GetProp("DefaultPriceScheduleID"); set => SetProp("DefaultPriceScheduleID", value); } - /// If true, when this product is ordered by a Buyer, it will automatically be added to a new Order from the Marketplace Owner to the Default Supplier and submitted. Requires a valid DefaultSupplierID. + /// If true, when this product is ordered by a buyer, it will automatically be added to a new order from the marketplace owner to the default supplier and submitted. Requires a valid DefaultSupplierID. public bool AutoForward { get => GetProp("AutoForward"); set => SetProp("AutoForward", value); } /// ID of the product. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 3. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } @@ -2463,19 +2463,19 @@ public class Product : OrderCloudModel public decimal? ShipWidth { get => GetProp("ShipWidth"); set => SetProp("ShipWidth", value); } /// Ship length of the product. public decimal? ShipLength { get => GetProp("ShipLength"); set => SetProp("ShipLength", value); } - /// If false, product is not visible or purchasable from the Shopper perspective. + /// If false, product is not visible or purchasable from a buyer's perspective. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } - /// Count of Specs assigned to the product. + /// Count of specs assigned to the product. [ApiReadOnly] public int SpecCount { get => GetProp("SpecCount"); set => SetProp("SpecCount", value); } - /// Count of Variants generated from the product/spec combinations. + /// Count of variants generated from the product/spec combinations. [ApiReadOnly] public int VariantCount { get => GetProp("VariantCount"); set => SetProp("VariantCount", value); } - /// Marketplace Owner or Supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. + /// Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. public string ShipFromAddressID { get => GetProp("ShipFromAddressID"); set => SetProp("ShipFromAddressID", value); } /// Inventory of the product. public Inventory Inventory { get => GetProp("Inventory"); set => SetProp("Inventory", value); } - /// If this property has a value and a SupplierID isn't explicitly passed when creating a LineItem, this SupplierID will be used. + /// Used for forwarding orders to suppliers. public string DefaultSupplierID { get => GetProp("DefaultSupplierID"); set => SetProp("DefaultSupplierID", value); } /// If true, all suppliers are eligible to opt into selling this product. public bool AllSuppliersCanSell { get => GetProp("AllSuppliersCanSell"); set => SetProp("AllSuppliersCanSell", value); } @@ -2495,7 +2495,7 @@ public class Product : Product } public class ProductAssignment : OrderCloudModel { - /// Marketplace owner can write to this property when creating product assignments for other sellers. A PriceScheduleID owned by the SellerID is required in order to write to this property. + /// Only the marketplace owner can override the SellerID on create. A price schedule owned by the supplier is required in order to write to this property. public string SellerID { get => GetProp("SellerID"); set => SetProp("SellerID", value); } /// ID of the product. Required. [Required] @@ -2568,19 +2568,19 @@ public class ProductCollectionBuyerProduct : OrderCloudModel public decimal? ShipWidth { get => GetProp("ShipWidth"); set => SetProp("ShipWidth", value); } /// Ship length of the product collection buyer product. public decimal? ShipLength { get => GetProp("ShipLength"); set => SetProp("ShipLength", value); } - /// If false, product is not visible or purchasable from the Shopper perspective. + /// If false, product is not visible or purchasable from a buyer's perspective. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } - /// Count of Specs assigned to the product. + /// Count of specs assigned to the product. [ApiReadOnly] public int SpecCount { get => GetProp("SpecCount"); set => SetProp("SpecCount", value); } - /// Count of Variants generated from the product/spec combinations. + /// Count of variants generated from the product/spec combinations. [ApiReadOnly] public int VariantCount { get => GetProp("VariantCount"); set => SetProp("VariantCount", value); } - /// Marketplace Owner or Supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. + /// Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. public string ShipFromAddressID { get => GetProp("ShipFromAddressID"); set => SetProp("ShipFromAddressID", value); } /// Inventory of the product collection buyer product. public Inventory Inventory { get => GetProp("Inventory"); set => SetProp("Inventory", value); } - /// If this property has a value and a SupplierID isn't explicitly passed when creating a LineItem, this SupplierID will be used. + /// Used for forwarding orders to suppliers. public string DefaultSupplierID { get => GetProp("DefaultSupplierID"); set => SetProp("DefaultSupplierID", value); } /// If true, all suppliers are eligible to opt into selling this product. public bool AllSuppliersCanSell { get => GetProp("AllSuppliersCanSell"); set => SetProp("AllSuppliersCanSell", value); } @@ -2624,7 +2624,7 @@ public class ProductCollectionInvitation : OrderCloudModel /// Updated when accepted. [ApiReadOnly] public bool Accepted { get => GetProp("Accepted", false); set => SetProp("Accepted", value); } - /// Invitation Expiration Date defaults to 30 days from create, maximum 1 year. + /// ExpirationDate defaults to 30 days from create, maximum 1 year. public DateTimeOffset? ExpirationDate { get => GetProp("ExpirationDate"); set => SetProp("ExpirationDate", value); } /// Container for extended (custom) properties of the product collection invitation. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -2641,11 +2641,11 @@ public class ProductCollectionProduct : OrderCloudModel public int? ListOrder { get => GetProp("ListOrder"); set => SetProp("ListOrder", value); } /// Date added of the product collection product. public DateTimeOffset? DateAdded { get => GetProp("DateAdded"); set => SetProp("DateAdded", value); } - /// ID of the organization that owns the Product. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the product. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } - /// When provided, no explicit PriceSchedule assignment is required. When a PriceSchedule assignment exists, it will override any default provided. + /// When provided, no explicit price schedule assignment is required. When a price schedule assignment exists, it will override any default provided. public string DefaultPriceScheduleID { get => GetProp("DefaultPriceScheduleID"); set => SetProp("DefaultPriceScheduleID", value); } - /// If true, when this product is ordered by a Buyer, it will automatically be added to a new Order from the Marketplace Owner to the Default Supplier and submitted. Requires a valid DefaultSupplierID. + /// If true, when this product is ordered by a buyer, it will automatically be added to a new order from the marketplace owner to the default supplier and submitted. Requires a valid DefaultSupplierID. public bool AutoForward { get => GetProp("AutoForward"); set => SetProp("AutoForward", value); } /// ID of the product collection product. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 3. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } @@ -2671,19 +2671,19 @@ public class ProductCollectionProduct : OrderCloudModel public decimal? ShipWidth { get => GetProp("ShipWidth"); set => SetProp("ShipWidth", value); } /// Ship length of the product collection product. public decimal? ShipLength { get => GetProp("ShipLength"); set => SetProp("ShipLength", value); } - /// If false, product is not visible or purchasable from the Shopper perspective. + /// If false, product is not visible or purchasable from a buyer's perspective. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } - /// Count of Specs assigned to the product. + /// Count of specs assigned to the product. [ApiReadOnly] public int SpecCount { get => GetProp("SpecCount"); set => SetProp("SpecCount", value); } - /// Count of Variants generated from the product/spec combinations. + /// Count of variants generated from the product/spec combinations. [ApiReadOnly] public int VariantCount { get => GetProp("VariantCount"); set => SetProp("VariantCount", value); } - /// Marketplace Owner or Supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. + /// Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs. public string ShipFromAddressID { get => GetProp("ShipFromAddressID"); set => SetProp("ShipFromAddressID", value); } /// Inventory of the product collection product. public Inventory Inventory { get => GetProp("Inventory"); set => SetProp("Inventory", value); } - /// If this property has a value and a SupplierID isn't explicitly passed when creating a LineItem, this SupplierID will be used. + /// Used for forwarding orders to suppliers. public string DefaultSupplierID { get => GetProp("DefaultSupplierID"); set => SetProp("DefaultSupplierID", value); } /// If true, all suppliers are eligible to opt into selling this product. public bool AllSuppliersCanSell { get => GetProp("AllSuppliersCanSell"); set => SetProp("AllSuppliersCanSell", value); } @@ -2708,7 +2708,7 @@ public class ProductFacet : OrderCloudModel /// Name of the product facet. Required. Max length 100 characters. Searchable: priority level 2. Sortable. [Required] public string Name { get => GetProp("Name"); set => SetProp("Name", value); } - /// Optional. Identifies full path to xp field used for this facet. If not provided, facet value assumed to be stored at product.xp.{facet ID}. + /// Identifies full path to XP field used for this facet. If not provided, facet value assumed to be stored at product.XP.{facet ID}. 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); } @@ -2748,12 +2748,12 @@ public class ProductSupplier : OrderCloudModel /// Name of the product supplier. Required. Max length 100 characters. Searchable: priority level 1. Sortable. [Required] public string Name { get => GetProp("Name"); set => SetProp("Name", value); } - /// If false, all authentication is prohibited. + /// If false, all user authentication is blocked. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } /// Date created of the product supplier. Sortable. [ApiReadOnly] public DateTimeOffset DateCreated { get => GetProp("DateCreated"); set => SetProp("DateCreated", value); } - /// If false, buyers will only be able to set ToCompanyID on an order to the Marketplace Owner, or suppliers they have an explicit relationship to. + /// If false, buyers will only be able to set ToCompanyID on an order to the marketplace owner, or suppliers they have an explicit relationship to. public bool AllBuyersCanOrder { get => GetProp("AllBuyersCanOrder"); set => SetProp("AllBuyersCanOrder", value); } /// Container for extended (custom) properties of the product supplier. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -2808,22 +2808,22 @@ public class Promotion : OrderCloudModel public string ItemSortBy { get => GetProp("ItemSortBy"); set => SetProp("ItemSortBy", value); } /// Description of the promotion. Max length 2000 characters. Searchable: priority level 4. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// Terms, conditions, and other legal jargon. + /// For reference only. Terms, conditions, and other legal jargon. public string FinePrint { get => GetProp("FinePrint"); set => SetProp("FinePrint", value); } /// Start date of the promotion. Sortable. public DateTimeOffset? StartDate { get => GetProp("StartDate"); set => SetProp("StartDate", value); } /// Expiration date of the promotion. Sortable. public DateTimeOffset? ExpirationDate { get => GetProp("ExpirationDate"); set => SetProp("ExpirationDate", value); } - /// The expression evaluated to determine if an item or order is eligible for a promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details. [Required] public string EligibleExpression { get => GetProp("EligibleExpression"); set => SetProp("EligibleExpression", value); } - /// The expression evaluated to determine the discount amount of an eligible promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details. public string ValueExpression { get => GetProp("ValueExpression"); set => SetProp("ValueExpression", value); } /// If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined. public bool CanCombine { get => GetProp("CanCombine"); set => SetProp("CanCombine", value); } - /// Allow promo to be used by all buyers in your Marketplace without creating explicit assignments. + /// Allow promo to be used by all buyers without creating explicit assignments. public bool AllowAllBuyers { get => GetProp("AllowAllBuyers"); set => SetProp("AllowAllBuyers", value); } - /// ID of the organization that owns the Promotion. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// Auto apply of the promotion. Sortable. public bool AutoApply { get => GetProp("AutoApply", false); set => SetProp("AutoApply", value); } @@ -2831,7 +2831,7 @@ public class Promotion : OrderCloudModel public bool Active { get => GetProp("Active", true); set => SetProp("Active", value); } /// Use integration of the promotion. public bool UseIntegration { get => GetProp("UseIntegration"); set => SetProp("UseIntegration", value); } - /// Used to control the order in which promotions are applied when calling the auto apply endpoint. + /// Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint. public int? Priority { get => GetProp("Priority"); set => SetProp("Priority", value); } /// Container for extended (custom) properties of the promotion. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -2877,7 +2877,7 @@ public class RefreshPromosResponse : OrderCloudModel { /// Promotions that were auto-applied. public IList PromosAdded { get => GetProp>("PromosAdded", new List()); set => SetProp>("PromosAdded", value); } - /// Promotions that were removed due to ineligibility or other reason. + /// Promotions that were removed due to ineligibility or other reasons. public IList PromosRemoved { get => GetProp>("PromosRemoved", new List()); set => SetProp>("PromosRemoved", value); } } /// Specific type of the PromosAdded property. If not using a custom type, specify AddedPromo. @@ -2888,7 +2888,7 @@ public class RefreshPromosResponse : RefreshPromos { /// Promotions that were auto-applied. public new IList PromosAdded { get => GetProp>("PromosAdded", new List()); set => SetProp>("PromosAdded", value); } - /// Promotions that were removed due to ineligibility or other reason. + /// Promotions that were removed due to ineligibility or other reasons. public new IList PromosRemoved { get => GetProp>("PromosRemoved", new List()); set => SetProp>("PromosRemoved", value); } } public class RemovedPromo : OrderCloudModel @@ -2925,22 +2925,22 @@ public class RemovedPromo : OrderCloudModel public string ItemSortBy { get => GetProp("ItemSortBy"); set => SetProp("ItemSortBy", value); } /// Description of the removed promo. Max length 2000 characters. Searchable: priority level 4. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// Terms, conditions, and other legal jargon. + /// For reference only. Terms, conditions, and other legal jargon. public string FinePrint { get => GetProp("FinePrint"); set => SetProp("FinePrint", value); } /// Start date of the removed promo. Sortable. public DateTimeOffset? StartDate { get => GetProp("StartDate"); set => SetProp("StartDate", value); } /// Expiration date of the removed promo. Sortable. public DateTimeOffset? ExpirationDate { get => GetProp("ExpirationDate"); set => SetProp("ExpirationDate", value); } - /// The expression evaluated to determine if an item or order is eligible for a promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details. [Required] public string EligibleExpression { get => GetProp("EligibleExpression"); set => SetProp("EligibleExpression", value); } - /// The expression evaluated to determine the discount amount of an eligible promotion. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details. public string ValueExpression { get => GetProp("ValueExpression"); set => SetProp("ValueExpression", value); } /// If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined. public bool CanCombine { get => GetProp("CanCombine"); set => SetProp("CanCombine", value); } - /// Allow promo to be used by all buyers in your Marketplace without creating explicit assignments. + /// Allow promo to be used by all buyers without creating explicit assignments. public bool AllowAllBuyers { get => GetProp("AllowAllBuyers"); set => SetProp("AllowAllBuyers", value); } - /// ID of the organization that owns the Promotion. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// Auto apply of the removed promo. Sortable. public bool AutoApply { get => GetProp("AutoApply", false); set => SetProp("AutoApply", value); } @@ -2948,7 +2948,7 @@ public class RemovedPromo : OrderCloudModel public bool Active { get => GetProp("Active", true); set => SetProp("Active", value); } /// Use integration of the removed promo. public bool UseIntegration { get => GetProp("UseIntegration"); set => SetProp("UseIntegration", value); } - /// Used to control the order in which promotions are applied when calling the auto apply endpoint. + /// Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint. public int? Priority { get => GetProp("Priority"); set => SetProp("Priority", value); } /// Container for extended (custom) properties of the removed promo. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -3029,9 +3029,9 @@ public class SecurityProfileAssignment : OrderCloudModel } public class SellerApprovalRule : OrderCloudModel { - /// ID of the organization who owns the rule. Only the MPO can write a value other than their own organization ID. The value is used to look up the ApprovingGroupID. + /// ID of the organization who owns the rule. Only the marketplace owner can write a value other than their own organization ID. The value is used to look up the ApprovingGroupID. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } - /// OrderReturn is the only Type supported currently. We plan to expand to Orders in the future. + /// OrderReturn is the only ApprovalType supported currently. [Required] public ApprovalType ApprovalType { get => GetProp("ApprovalType"); set => SetProp("ApprovalType", value); } /// ID of the seller approval rule. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 1. Sortable: priority level 2. @@ -3043,7 +3043,7 @@ public class SellerApprovalRule : OrderCloudModel /// ID of the approving group. Required. Sortable. [Required] public string ApprovingGroupID { get => GetProp("ApprovingGroupID"); set => SetProp("ApprovingGroupID", value); } - /// The expression evaluated to determine an order requires approval. See Rules Engine documentation for formatting details. + /// The expression evaluated to determine an order requires approval. See rules engine documentation for formatting details. [Required] public string RuleExpression { get => GetProp("RuleExpression"); set => SetProp("RuleExpression", value); } /// Container for extended (custom) properties of the seller approval rule. @@ -3125,7 +3125,7 @@ public class Shipment : OrderCloudModel public string BuyerID { get => GetProp("BuyerID"); set => SetProp("BuyerID", value); } /// For reference only, does not influence any OrderCloud behavior. public string Shipper { get => GetProp("Shipper"); set => SetProp("Shipper", value); } - /// In order to properly trigger OrderShipped emails, this date must be NULL on initial POST. Update with the date only when all of the Shipment items have been created. Once all of an order's items exist on a shipment that has a DateShipped the OrderShipped email will trigger and Order.Status will be updated to Complete. + /// In order to properly trigger OrderShipped emails, this date must be NULL on initial create. Update with the date only when all of the Shipment items have been created. Once all of an order's items exist on a shipment that has a DateShipped populated the OrderShipped message sender will trigger and Order.Status will be updated to Complete. public DateTimeOffset? DateShipped { get => GetProp("DateShipped"); set => SetProp("DateShipped", value); } /// Date delivered of the shipment. Searchable: priority level 4. Sortable. public DateTimeOffset? DateDelivered { get => GetProp("DateDelivered"); set => SetProp("DateDelivered", value); } @@ -3133,13 +3133,13 @@ public class Shipment : OrderCloudModel public string TrackingNumber { get => GetProp("TrackingNumber"); set => SetProp("TrackingNumber", value); } /// For reference only, does not influence any OrderCloud behavior. public decimal? Cost { get => GetProp("Cost"); set => SetProp("Cost", value); } - /// ID of the organization that owns the Shipment. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the shipment. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// Container for extended (custom) properties of the shipment. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } /// Account of the shipment. public string Account { get => GetProp("Account"); set => SetProp("Account", value); } - /// Marketplace Owner or Supplier AddressID where the product will be shipped from. + /// Marketplace owner or supplier AddressID where the product will be shipped from. public string FromAddressID { get => GetProp("FromAddressID"); set => SetProp("FromAddressID", value); } /// ID of the to address. public string ToAddressID { get => GetProp("ToAddressID"); set => SetProp("ToAddressID", value); } @@ -3195,7 +3195,7 @@ public class ShipmentItem : OrderCloudModel /// Specs of the shipment item. [ApiReadOnly] public IReadOnlyList Specs { get => GetProp>("Specs"); set => SetProp>("Specs", value); } - /// For reference only, represents LineItem XP from the given LineItem ID + /// For reference only, represents line item XP from the given line item ID [ApiReadOnly] public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } } @@ -3206,7 +3206,7 @@ public class ShipmentItem : ShipmentItem where TProduct : LineItemProduct where TVariant : LineItemVariant { - /// For reference only, represents LineItem XP from the given LineItem ID + /// For reference only, represents line item XP from the given line item ID [ApiReadOnly] public new Txp xp { get => GetProp("xp"); set => SetProp("xp", value); } /// Product of the shipment item. @@ -3246,7 +3246,7 @@ public class ShipMethodSelection : OrderCloudModel } public class Spec : OrderCloudModel { - /// ID of the organization that owns the Spec. Only the Marketplace Owner can override the OwnerID on create. + /// ID of the organization that owns the spec. Only the marketplace owner can override the OwnerID on create. public string OwnerID { get => GetProp("OwnerID"); set => SetProp("OwnerID", value); } /// ID of the spec. Can only contain characters Aa-Zz, 0-9, -, and _. Searchable: priority level 2. Sortable: priority level 3. public string ID { get => GetProp("ID"); set => SetProp("ID", value); } @@ -3255,15 +3255,15 @@ public class Spec : OrderCloudModel /// Name of the spec. Required. Searchable: priority level 1. Sortable: priority level 2. [Required] public string Name { get => GetProp("Name"); set => SetProp("Name", value); } - /// If no Spec.Value is passed in the LineItemSpec, this value will be used. + /// If no value is passed in the line item spec, this value will be used. public string DefaultValue { get => GetProp("DefaultValue"); set => SetProp("DefaultValue", value); } /// Required of the spec. public bool Required { get => GetProp("Required"); set => SetProp("Required", value); } - /// For Spec options that are not pre-defined, such as FirstName for a business card. + /// For spec options that are not pre-defined, such as FirstName for a business card. public bool AllowOpenText { get => GetProp("AllowOpenText"); set => SetProp("AllowOpenText", value); } - /// This property can only be written to after both the Spec and Option have been created. If no Spec.OptionID is passed in the LineItemSpec, this option will be used. + /// This property can only be written to after both the spec and options have been created. If no Spec.OptionID is passed in the line item spec, this option will be used. public string DefaultOptionID { get => GetProp("DefaultOptionID"); set => SetProp("DefaultOptionID", value); } - /// If true, each unique combinations of this Spec's Options should map to a unique Product Variant. + /// If true, each unique combinations of this spec's options should map to a unique product variant. public bool DefinesVariant { get => GetProp("DefinesVariant"); set => SetProp("DefinesVariant", value); } /// Container for extended (custom) properties of the spec. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -3296,7 +3296,7 @@ public class SpecOption : OrderCloudModel public int ListOrder { get => GetProp("ListOrder"); set => SetProp("ListOrder", value); } /// Is open text of the spec option. public bool IsOpenText { get => GetProp("IsOpenText"); set => SetProp("IsOpenText", value); } - /// Used to change the price of a product when a specific Spec Option is selected. + /// Used to change the price of a product when a specific spec option is selected. public PriceMarkupType? PriceMarkupType { get => GetProp("PriceMarkupType"); set => SetProp("PriceMarkupType", value); } /// Price markup of the spec option. public decimal? PriceMarkup { get => GetProp("PriceMarkup"); set => SetProp("PriceMarkup", value); } @@ -3317,9 +3317,9 @@ public class SpecProductAssignment : OrderCloudModel /// ID of the product. Required. Searchable: priority level 2. Sortable: priority level 2. [Required] public string ProductID { get => GetProp("ProductID"); set => SetProp("ProductID", value); } - /// Optional. When defined, overrides the DefaultValue set on the Spec for just this Product. + /// When defined, overrides the DefaultValue set on the spec for this product only. public string DefaultValue { get => GetProp("DefaultValue"); set => SetProp("DefaultValue", value); } - /// Optional. When defined, overrides the DefaultOptionID set on the Spec for just this Product. + /// When defined, overrides the DefaultOptionID set on the spec for this product only. public string DefaultOptionID { get => GetProp("DefaultOptionID"); set => SetProp("DefaultOptionID", value); } } public class SpendingAccount : OrderCloudModel @@ -3332,7 +3332,7 @@ public class SpendingAccount : OrderCloudModel /// Balance of the spending account. Required. [Required] public decimal Balance { get => GetProp("Balance"); set => SetProp("Balance", value); } - /// If true, a Payment can be created referencing the SpendingAccountID. + /// If true, a payment can be created referencing the SpendingAccountID. public bool AllowAsPaymentMethod { get => GetProp("AllowAsPaymentMethod"); set => SetProp("AllowAsPaymentMethod", value); } /// Start date of the spending account. public DateTimeOffset? StartDate { get => GetProp("StartDate"); set => SetProp("StartDate", value); } @@ -3375,7 +3375,7 @@ public class Subscription : OrderCloudModel /// Last order date of the subscription. Sortable: priority level 2. [ApiReadOnly] public DateTimeOffset? LastOrderDate { get => GetProp("LastOrderDate"); set => SetProp("LastOrderDate", value); } - /// Date that Subscription Order reminder email message sender will be sent if used. Value is the result of NextOrderDate minus NotificationDays on SubscriptionIntegration. + /// Date that subscription order reminder message sender will be triggered if used. Value is the result of NextOrderDate less NotificationDays on the subscription integration. [ApiReadOnly] public DateTimeOffset? NotificationDate { get => GetProp("NotificationDate"); set => SetProp("NotificationDate", value); } /// Date created of the subscription. Sortable: priority level 3. @@ -3385,11 +3385,11 @@ public class Subscription : OrderCloudModel public DateTimeOffset? EndDate { get => GetProp("EndDate"); set => SetProp("EndDate", value); } /// Active of the subscription. public bool Active { get => GetProp("Active", true); set => SetProp("Active", value); } - /// Only use when creating a subscription on behalf of another user. ID of the Buyer or Marketplace Owner placing the order. + /// Only use when creating a subscription on behalf of another user. ID of the buyer or marketplace owner placing the order. public string FromCompanyID { get => GetProp("FromCompanyID"); set => SetProp("FromCompanyID", value); } /// Only use when creating a subscription on behalf of a another user. public string FromUserID { get => GetProp("FromUserID"); set => SetProp("FromUserID", value); } - /// ID of the Marketplace Owner or Supplier receiving the order created by this subscription, only writable on create. Mainly useful to the user placing it. + /// ID of the marketplace owner or supplier receiving the order created by this subscription, only writable on create. public string ToCompanyID { get => GetProp("ToCompanyID"); set => SetProp("ToCompanyID", value); } /// Payment of the subscription. public SubscriptionPayment Payment { get => GetProp("Payment"); set => SetProp("Payment", value); } @@ -3408,7 +3408,7 @@ public class Subscription : Subscription } public class SubscriptionIntegration : OrderCloudModel { - /// ID of the API Client that will be used to generate the token passed to your hosted application via SubscriptionIntegrationPayload.OrderCloudAccessToken. + /// ID of the API client that will be used to generate the token passed to your hosted application via subscription integration. [Required] public string ApiClientID { get => GetProp("ApiClientID"); set => SetProp("ApiClientID", value); } /// Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data. @@ -3469,12 +3469,12 @@ public class Supplier : OrderCloudModel /// Name of the supplier. Required. Max length 100 characters. Searchable: priority level 1. Sortable. [Required] public string Name { get => GetProp("Name"); set => SetProp("Name", value); } - /// If false, all authentication is prohibited. + /// If false, all user authentication is blocked. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } /// Date created of the supplier. Sortable. [ApiReadOnly] public DateTimeOffset DateCreated { get => GetProp("DateCreated"); set => SetProp("DateCreated", value); } - /// If false, buyers will only be able to set ToCompanyID on an order to the Marketplace Owner, or suppliers they have an explicit relationship to. + /// If false, buyers will only be able to set ToCompanyID on an order to the marketplace owner, or suppliers they have an explicit relationship to. public bool AllBuyersCanOrder { get => GetProp("AllBuyersCanOrder"); set => SetProp("AllBuyersCanOrder", value); } /// Container for extended (custom) properties of the supplier. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } @@ -3593,7 +3593,7 @@ public class User : OrderCloudModel /// ID of the company. [ApiReadOnly] public string CompanyID { get => GetProp("CompanyID"); set => SetProp("CompanyID", value); } - /// Must be unique across the Marketplace. + /// Must be unique across all organizations. [Required] public string Username { get => GetProp("Username"); set => SetProp("Username", value); } /// Password of the user. @@ -3617,10 +3617,10 @@ public class User : OrderCloudModel public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } /// Container for extended (custom) properties of the user. public dynamic xp { get => GetProp("xp", new ExpandoObject()); set => SetProp("xp", value); } - /// List of Roles currently available to the user via all SecurityProfile Assignments. + /// List of roles currently available to the user via all security profile assignments. [ApiReadOnly] public IReadOnlyList AvailableRoles { get => GetProp>("AvailableRoles"); set => SetProp>("AvailableRoles", value); } - /// Most specific Locale assigned to the user, if any. + /// Most specific locale assigned to the user, if any. [ApiReadOnly] public Locale Locale { get => GetProp("Locale"); set => SetProp("Locale", value); } /// Date created of the user. Sortable. @@ -3674,7 +3674,7 @@ public class Variant : OrderCloudModel public string Name { get => GetProp("Name"); set => SetProp("Name", value); } /// Description of the variant. Max length 2000 characters. Searchable: priority level 3. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// If false, variant is not visible or purchasable from the Shopper perspective. + /// If false, variant is not visible or purchasable from a buyer's perspective. public bool Active { get => GetProp("Active"); set => SetProp("Active", value); } /// Ship weight of the variant. public decimal? ShipWeight { get => GetProp("ShipWeight"); set => SetProp("ShipWeight", value); } @@ -3739,19 +3739,19 @@ public class Webhook : OrderCloudModel public string Name { get => GetProp("Name"); set => SetProp("Name", value); } /// Description of the webhook. Max length 2000 characters. Searchable: priority level 3. public string Description { get => GetProp("Description"); set => SetProp("Description", value); } - /// URL the WebHook will POST data to, likely a route within your middleware and required unless there is a valid deliveryConfig. + /// URL the webhook will POST data to, likely a route within your middleware. Required unless there is a valid DeliveryConfig. public string Url { get => GetProp("Url"); set => SetProp("Url", value); } /// Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data. public string HashKey { get => GetProp("HashKey"); set => SetProp("HashKey", value); } - /// If you need additional data not provided by the WebHook payload, you can request any elevated roles needed to make additional calls. + /// If you need additional data not provided by the webhook payload, you can request any elevated roles needed to make additional calls. public IList ElevatedRoles { get => GetProp>("ElevatedRoles", new List()); set => SetProp>("ElevatedRoles", value); } /// Config data of the webhook. public object ConfigData { get => GetProp("ConfigData"); set => SetProp("ConfigData", value); } - /// If true, the Webhook is processed prior to the call being made and OrderCloud waits for a response before proceeding. + /// If true, the webhook is processed prior to the call being made and OrderCloud waits for a response before proceeding. public bool BeforeProcessRequest { get => GetProp("BeforeProcessRequest"); set => SetProp("BeforeProcessRequest", value); } - /// List of API ClientIDs the WebHook will be triggered for. + /// List of API client IDs the webhook will be triggered for. public IList ApiClientIDs { get => GetProp>("ApiClientIDs", new List()); set => SetProp>("ApiClientIDs", value); } - /// List of routes the WebHook will be triggered for. + /// List of routes the webhook will be triggered for. public IList WebhookRoutes { get => GetProp>("WebhookRoutes", new List()); set => SetProp>("WebhookRoutes", value); } /// ID of the delivery config. public string DeliveryConfigID { get => GetProp("DeliveryConfigID"); set => SetProp("DeliveryConfigID", value); } diff --git a/src/OrderCloud.SDK/OrderCloud.SDK.csproj b/src/OrderCloud.SDK/OrderCloud.SDK.csproj index 9cd693e..2ed672e 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.8 + 0.18.9 OrderCloud.SDK OrderCloud SDK Todd Menier