<?xml version="1.0"?>
<doc>
<assembly>
<name>OroCommerce.Data</name>
</assembly>
<members>
<member name="T:Integration.Constants.ScopeAction">
<summary>
Scope actions for scopes
</summary>
</member>
<member name="T:Integration.Template.Utilities.BatchExecution">
<summary>
This class is an optional utility that implementers may find useful. It allows queuing API calls
and executing them in parallel batches. For example, when sending a product to an external system
where each of its variants requires a separate API call, running them sequentially can be slow.
Instead, you can queue the variant API calls and execute them in batches for better performance.
If no batch size is specified, the iPaaS setting for "Concurrent Batch Executions" will be used.
<para>
Sample usage:
</para>
<code>
var variantPutAndPostCalls = new List<APICall>();
var responseVariants = new List<Variants>();
foreach (var variant in variants)
{
variantPutAndPostCalls.Add(await wrapper.Product_PUT_ConstructAPICall(variant));
}
var batchExecutionVariants = new BatchExecution(variantPutAndPostCalls, stopProcessingAfterException: true);
try
{
var successfulResponses = await batchExecutionVariants.ExecuteAPICallsInBatch<CatalogDataProductInterface>();
if (successfulResponses != null)
responseVariants.AddRange(successfulResponses);
}
catch (Exception ex)
{
throw new ExpectedException(ex.Message) { SavedExternalData = responseVariants };
}
</code>
</summary>
</member>
<member name="T:OroCommerce.Data.Interface.APICall.NotFoundActionEnum">
<summary>
Not Found Actions?
</summary>
</member>
<member name="M:OroCommerce.Data.Interface.APICall.ProcessBatchRequestAsync">
<summary>
This method will call ProcessRequestAsync and either return the response, or an exception. This is used by the BatchExecution class to allow multiple method calls
and handle any exceptions that come up.
</summary>
<returns></returns>
</member>
<member name="M:OroCommerce.Data.Interface.ConversionFunctions.GetOrganizationIdByNameAsync(System.String)">
<summary>
GetOrganizationIdByNameAsync
This async method uses a given organization name to find the corresponding
organization ID by matching the name with existing organizations.
</summary>
<example>
Example Usage:
string organizationName = "Acme Corp";
string organizationId = await GetOrganizationIdByNameAsync(organizationName);
Explanation:
In this example, the method takes the organization name "Acme Corp",
validates the input, and retrieves the Id of the organization
that matches the given name.
Returns:
The organization Id as a string, or null if not found.
</example>
<remarks>
Usage Notes:
This method retrieves the organization Id corresponding to a given
organization name. It can be used in scenarios where an organization
identifier is required based on a known organization name.
Data Types:
organizationName => string
</remarks>
<param name="organizationName">
Description: The organization name to search for in OroCommerce.
</param>
<returns>
string
</returns>
</member>
<member name="M:OroCommerce.Data.Interface.ConversionFunctions.GetUserIdByUsernameAsync(System.String)">
<summary>
GetUserIdByUsernameAsync
This async method uses a given username to find the corresponding
User ID in OroCommerce by matching the username exactly.
</summary>
<example>
Example Usage:
string username = "admin";
string userId = await GetUserIdByUsernameAsync(username);
Explanation:
In this example, the method takes the username "john.doe",
validates the input, and retrieves the Id of the user
that matches the given username.
Returns:
The user Id as a string, or null if not found.
</example>
<remarks>
Usage Notes:
This method retrieves the user Id corresponding to a given
username. It can be used in scenarios where a user identifier
is required based on a known username.
Data Types:
username => string
</remarks>
<param name="username">
Description: The username to search for in OroCommerce.
</param>
<returns>
string
</returns>
</member>
<member name="M:OroCommerce.Data.Interface.ConversionFunctions.GetCustomerTaxCodeIdByTaxCodeAsync(System.String)">
<summary>
GetTaxCodeIdByTaxCodeAsync
This async method uses a given tax code (search text) to find the corresponding
tax code ID in OroCommerce by matching the search text exactly.
</summary>
<example>
Example Usage:
string searchText = "STATE_GOVERNMENT";
string taxCodeId = await GetCustomerTaxCodeIdByTaxCodeAsync(taxCode);
Explanation:
In this example, the method takes the tax code "STATE_GOVERNMENT",
validates the input, and retrieves the Id of the tax code
that matches the given search text.
Returns:
The tax code Id as a string, or null if not found.
</example>
<remarks>
Usage Notes:
This method retrieves the tax code Id corresponding to a given
tax code value. It can be used in scenarios where a tax code
identifier is required for further processing.
Data Types:
searchText => string
</remarks>
<param name="taxCode">
Description: The tax code to search for in OroCommerce.
</param>
<returns>
string
</returns>
</member>
<member name="M:OroCommerce.Data.Interface.ConversionFunctions.GetPaymentTermIdByPaymentTermAsync(System.String)">
<summary>
GetPaymentTermIdByPaymentTermAsync
This async method uses a given payment term value to find the corresponding
payment term ID in OroCommerce by matching the search text exactly
</summary>
<example>
Example Usage:
string searchText = "Net 30";
string paymentTermId = await GetPaymentTermIdByPaymentTermAsync(searchText);
Explanation:
In this example, the method takes the payment term "Net 30",
validates the input, and retrieves the Id of the payment term
that matches the given search text.
Returns:
The payment term Id as a string, or null if not found.
</example>
<remarks>
Usage Notes:
This method retrieves the payment term Id corresponding to a given
payment term value. It can be used in scenarios where a payment term
identifier is required for further processing.
Data Types:
searchText => string
</remarks>
<param name="paymentTerm">
Description: The payment term to search for in OroCommerce.
</param>
<returns>
string
</returns>
</member>
<member name="M:OroCommerce.Data.Interface.ConversionFunctions.GetProductTaxCodeIdByTaxCodeAsync(System.String)">
<summary>
GetProductTaxCodeIdByTaxCodeAsync
This async method uses a given tax code to find the corresponding
product tax code ID by matching the tax code with existing product tax codes.
</summary>
<example>
Example Usage:
string taxCode = "TAXABLE_ITEMS";
string productTaxCodeId = await GetProductTaxCodeIdByTaxCodeAsync(taxCode);
Explanation:
In this example, the method takes the tax code "TAXABLE_ITEMS",
validates the input, and retrieves the Id of the product tax code
that matches the given tax code.
Returns:
The product tax code Id as a string, or null if not found.
</example>
<remarks>
Usage Notes:
This method retrieves the product tax code Id corresponding to a given
tax code. It can be used in scenarios where a product tax code identifier
is required based on a known tax code.
Data Types:
taxCode => string
</remarks>
<param name="taxCode">
Description: The tax code used to search for the corresponding ProductTaxCode in OroCommerce.
</param>
<returns>
string
</returns>
</member>
<member name="M:OroCommerce.Data.Interface.ConversionFunctions.GetBusinessUnitIdByNameAsync(System.String)">
<summary>
GetBusinessUnitIdByNameAsync
This async method uses a given business unit name to find the corresponding
business unit ID by matching the name with existing business units.
</summary>
<example>
Example Usage:
string businessUnitName = "Sales Department";
string businessUnitId = await GetBusinessUnitIdByNameAsync(businessUnitName);
Explanation:
In this example, the method takes the business unit name "Sales Department",
validates the input, and retrieves the Id of the business unit
that matches the given name.
Returns:
The business unit Id as a string, or null if not found.
</example>
<remarks>
Usage Notes:
This method retrieves the business unit Id corresponding to a given
business unit name. It can be used when a business unit identifier
is required based on a known business unit name.
Data Types:
businessUnitName => string
</remarks>
<param name="businessUnitName">
Description: The business unit name to search for in OroCommerce.
</param>
<returns>
string
</returns>
</member>
<member name="M:OroCommerce.Data.Interface.ConversionFunctions.GetAttributeFamilyIdByCodeAsync(System.String)">
<summary>
GetAttributeFamilyIdByCodeAsync
This async method uses a given attribute family code to find the corresponding
attribute family ID by matching the code with existing attribute families.
</summary>
<example>
Example Usage:
string attributeFamilyCode = "default_family";
string attributeFamilyId = await GetAttributeFamilyIdByCodeAsync(attributeFamilyCode);
Explanation:
In this example, the method takes the attribute family code "default_family",
validates the input, and retrieves the Id of the attribute family
that matches the given code.
Returns:
The attribute family Id as a string, or null if not found.
</example>
<remarks>
Usage Notes:
This method retrieves the attribute family Id corresponding to a given
attribute family code. It can be used when an attribute family identifier
is required based on a known attribute family code.
Data Types:
attributeFamilyCode => string
</remarks>
<param name="attributeFamilyCode">
Description: The attribute family code to search for in OroCommerce.
</param>
<returns>
string
</returns>
</member>
<member name="M:OroCommerce.Data.Interface.ConversionFunctions.GetProductUnitIdByLabelAsync(System.String)">
<summary>
GetProductUnitIdByLabelAsync
This async method uses a given product unit label to find the corresponding
product unit ID by matching the label with existing product units.
</summary>
<example>
Example Usage:
string productUnitLabel = "piece";
string productUnitId = await GetProductUnitIdByLabelAsync(productUnitLabel);
Explanation:
In this example, the method takes the product unit label "piece",
validates the input, and retrieves the Id of the product unit
that matches the given label.
Returns:
The product unit Id as a string, or null if not found.
</example>
<remarks>
Usage Notes:
This method retrieves the product unit Id corresponding to a given
product unit label. It can be used when a product unit identifier
is required based on a known product unit label.
Data Types:
productUnitLabel => string
</remarks>
<param name="productUnitLabel">
Description: The product unit label to search for in OroCommerce.
</param>
<returns>
string
</returns>
</member>
<member name="M:OroCommerce.Data.Interface.ConversionFunctions.GetProductRelationshipsDataAsync(System.String,System.String,System.String)">
<summary>
GetProductRelationshipsDataAsync
This async method performs an API call to retrieve relationship data for a given product Id
and relationship name, and optionally filters the result by a specific record Id.
</summary>
<example>
Example Usage:
var unitPrecisions = await GetProductRelationshipsDataAsync(
"unitPrecisions",
"12345",
null
);
Explanation:
This example calls:
/api/products/12345/unitPrecisions
to retrieve unit Precisions data.
Returns:
A list of GenericFilterData objects, or null if not found.
</example>
<remarks>
Usage Notes:
This overload performs the actual API call and response processing.
If a specific recordId is supplied, the returned list will be filtered
to only include matching Id items.
Data Types:
relationshipName => string
productId => string
recordId => string (optional)
</remarks>
<param name="relationshipName">
Description: The name of the relationship to retrieve (e.g. unitPrecisions).
</param>
<param name="productId">
Description: The product Id whose relationship entries are requested.
</param>
<param name="recordId">
Description: (Optional) A specific relationship item Id used to filter the results.
</param>
<returns>
List<GenericFilterData>
</returns>
</member>
<member name="M:OroCommerce.Data.Interface.MetaData.GenerateTableInfo(System.String,System.String,System.Int32,System.Type)">
<summary>
This is a quick and dirty way to populate all fields and properties from a given class. For most fields in most classes, this will be fine,
but there is no sophisticated handling for e.g. JsonIgnored fields. So any modifications to the standard output of this method would need to be handled
manually (e.g. you could use the proc to generate a fieldinfo list, then add or remove fields as necessary)
</summary>
<param name="name"></param>
<param name="description"></param>
<param name="mappingCollectionTypeId"></param>
<param name="type"></param>
<returns></returns>
</member>
<member name="M:OroCommerce.Data.Interface.TranslationUtilities.UpdateWebhookSubscriptionAsync(Integration.Abstract.Connection,System.String,System.Boolean)">
<summary>
</summary>
<param name="mappingCollectionType"></param>
<returns></returns>
</member>
<member name="M:OroCommerce.Data.Interface.TranslationUtilities.EstimateTotalAPICallsMade(Integration.Abstract.Connection,System.Int32,System.Object)">
<summary>
Allows an external DLL to estimate how many API calls will be needed for a each CREATE events in order to claim the slots against rate limit settings at the beginning.
Once the transfer is complete, actual API calls will be compared to the claimed API calls and will adjust the available API call limit up or down as necessary.
</summary>
<param name="mappingCollectionType"></param>
<returns></returns>
</member>
<member name="M:OroCommerce.Data.Interface.TranslationUtilities.ProcessAuthorization(Integration.Abstract.Connection,Integration.Abstract.Model.Authorization)">
<summary>
This is an optionally overridable function that allows us to process authorization data (e.g. convert temporary OAuth values into a
set of permanent keys.
</summary>
<param name="connection"></param>
<param name="authorization"></param>
</member>
<member name="M:OroCommerce.Data.IPaaSApi.IPaaSApiCallWrapper.ProcessFullErrorMessage(RestSharp.RestResponse)">
<summary>
Convert the RestResponse into a fully parsed, human readable error message.
</summary>
<param name="resp"></param>
<returns></returns>
</member>
<member name="M:OroCommerce.Data.Models.OAuthAccess.Get(OroCommerce.Data.Interface.CallWrapper,System.String,System.String,System.String,System.String,System.String)">
<summary>
This method retrieves an OAuth access token using the authorization code grant type.
</summary>
<param name="activeCallWrapper"></param>
<param name="redirectUrl"></param>
<param name="code"></param>
<param name="clientId"></param>
<param name="clientSecret"></param>
<param name="codeVerifier"></param>
<returns></returns>
<exception cref="T:System.UnauthorizedAccessException"></exception>
</member>
<member name="M:OroCommerce.Data.Models.OAuthAccess.SaveRefreshToken(OroCommerce.Data.Interface.CallWrapper,System.String,System.String,System.String)">
<summary>
This method saves a new OAuth access token using the refresh token grant type.
</summary>
<param name="activeCallWrapper"></param>
<param name="refreshToken"></param>
<param name="clientId"></param>
<param name="clientSecret"></param>
<returns></returns>
<exception cref="T:System.UnauthorizedAccessException"></exception>
</member>
<member name="T:OroCommerce.Data.Utilities.RestSharpNewtonsoftSerializer">
<summary>
As of RestSharp 1.0.7, there is no official support for newtonsoft, nor is there a documented way to add default serialization settings. So we solve both problems
with this class: it implements the newtonsoft serializer and sets default null handling to our standard style.
</summary>
</member>
</members>
</doc>