Search Results for

    Show / Hide Table of Contents

    Namespace DirectScale.Disco.Extension

    Classes

    AchPayment

    AddPaymentFrameData

    Address

    This represents an individual address.

    Adjustment

    AdjustmentStatus

    AmountType

    Indicates if the discount should be a fixed amount or a percentage.

    Application

    All of the information required to enroll a new associate. Can also be used to upgrade an associate from a retail customer to a distributor.

    ApplicationOrder

    This is the information needed to create a new order at enrollment time.

    ApplicationResponse

    Associate

    This is all the basic information for an associate.

    AssociateCommissionResult

    AssociateCreatedMessage

    Class for representing the AssociateCreated event's message

    AssociateCustomFields

    Associates can have up to 10 custom fields.

    AssociateDeletedMessage

    Class for representing the AssociateDeleted event's message

    AssociateEditedMessage

    Class for representing the AssociateEdited event's message

    AssociateStatusEditedMessage

    Class for representing the AssociateStatusEdited event's message

    Autoship

    AutoshipCreatedMessage

    Class for representing the AutoshipCreated event's message

    AutoshipEditedMessage

    Class for representing the AutoshipEdited event's message

    AutoshipOrderInfo

    AutoshipType

    AuxiliaryData

    AvaliableComponent

    Indicates which features are enabled.

    Bom

    BomGroup

    BonusDetail

    BonusPayStatus

    Category

    CategoryTranslation

    CommissionCheck

    CommissionCheckDetail

    CommissionHistoryDetail

    This is the in-depth details for a bonus earned by an associate during a commission period.

    CommissionHistorySummary

    This is the basic summary for the total amount an associate earned for a specific bonus during a commission period.

    CommissionMerchant

    Extend this class to create a new custom money out merchant implementation.

    CommissionMerchantAccountFields

    CommissionMerchantBase

    CommissionMerchantCustomField

    Used to define information for this merchant to process payments. For example, an associate might have a specific account number or access token that must be created before payments can be made. These values are usually defined when the associate selects this merchant to receive their payments, and are then passed into the custom merchant when the payment is being processed.

    CommissionOverride

    IOverrideService is used to manage manual commission overrides for rules, ranks, and bonuses

    CommissionPayment

    Represents the status of an individual commission payment.

    CommissionPaymentDetail

    CommissionPaymentResult

    Represenst the result of an individual payment which has been processed.

    CommissionPaymentResults

    The results of processing a payment batch.>

    CommissionPaymentSplit

    CommissionPaymentStatus

    CommissionRuleResult

    CommissionStats

    Represents all of an associate's stats during a commission period.

    CommittedDetails

    Company

    Contributor

    Shows how much was paid from an individual order towards someone's bonus

    Country

    CountryLanguage

    Coupon

    Represents a coupon that that can be used for a discount.

    CouponAdjustedVolume

    CouponType

    Indicates how the coupon is applied.

    CSSColors

    Represents the branding colors used.

    CSSImagePaths

    Represents the CMS paths to various icons.

    Currency

    Represents a specific country's currency. Managed in the currency admin page.

    CustomFields

    CustomPageRegistration

    CustomTree

    CustomVolumeSource

    This is a custom volume source that can be used to add additional values into the commission template that are not normally included. This could be any kind of points or values for an associate, that can be represented as a float.

    Discount

    DiscountType

    EmailMessage

    EmailOnNotificationEvent

    EnvironmentType

    Enum value for the Extension environment type.

    EventHandlerRegistration

    EventType

    ExtensionContext

    Context information about the extension hosting environment

    ExternalSyncVendor

    FastStartBonuses

    FindAssociateResult

    FraudPreventionCallback

    FraudPreventionData

    FraudPreventionInfo

    FraudPreventionTypeEnum

    FraudReviewStatus

    Frequency

    HookRegistration

    Iframe

    ImportLineItem

    InventoryItem

    ItemImage

    ItemOption

    ItemOptionKeyMap

    ItemOptionValues

    Kpi

    Key Performance Indicators (KPIs) are the results of a kpi or condition.

    KPIReEntryRule

    LanguageMap

    LegName

    LineItem

    LineItemOption

    LineItemPrice

    Localization

    Location

    Merchant

    MerchantRegistration

    MerchantType

    MoneyInEndpoints

    MoneyInMerchant

    IMoneyInMerchant Is the base class for creating custom money in merchants. It provides default implementations where possible. Do not implement directly. You must implement one of the children abstract classes: SavedPaymentMoneyInMerchant, SinglePaymentMoneyInMerchant, or RedirectMoneyInMerchant. SavedPaymentMoneyInMerchant is normally used to tokenize and process credit cards. SinglePaymentMoneyInMerchant is used to process payments without saved payment data. This can be something that can be looked up by the associate, like reward points. RedirectMoneyInMerchant is used to forward the customer to the merchant's site to complete an order. This is done if the merchant can't process the payment as two separate steps (tokenize card, then charge card) and instead needs to control the full payment process. After the customer hits submit order, the order will be created in a pending state until they have completed the payment. Normally, after the payment is completed from the merchant's site, the merchant will then call a provided custom API endpoint to send the results of the attempted payment.

    MoneyOutEndpoints

    MoveOrderMessageType

    MoveOrderPermission

    NewOrderDetail

    This is the information needed to create a new order.

    NewPayment

    NewPaymentMethod

    Node

    NodeDetail

    NodeId

    This indicates a placement in a tree. Most of the time TreeIndex will be 0 and only the AssociateId will be used, unless you allow associates to be placed in the same tree multiple times (Should only applies Matrix trees).

    NomenclatureInfo

    Represents the company configured specific terminology used for these terms.

    NotificationEvent

    OnFileMerchant

    OnFileProfile

    Order

    OrderCoupon

    This is a specific time a coupon was used on an order, which order it was used on, and how much of a discount it gave.

    OrderCoupons

    Represents all of the coupons used in an order.

    OrderCreatedMessage

    Class for representing the OrderCreated event's message

    OrderLineItem

    OrderPackage

    OrderPayment

    OrderPaymentStatus

    OrderPaymentStatusUpdate

    OrderSource

    This is the source that the order came from

    OrderStatus

    OrderTotal

    OrderType

    OutcomeHandoffMessage

    Class for representing the OutcomeHandoff event's message

    OverridePeriod

    Used to determin if a CommissionOverride is valid for a specific period.

    PackageStatusUpdate

    Party

    PartyStatus

    Payment

    PaymentMethod

    PaymentMethodBillingInfo

    PaymentProcessStatus

    PaymentResponse

    This is the result of processing a charge or refund transaction.

    PaymentResult

    PaymentResultDetail

    PaymentStatus

    Period

    PeriodType

    Placement

    PlacementAction

    PointsItem

    Rank

    The information about a rank.

    RankDate

    Specifies a Rank and when it was obtained.

    RankDetail

    This is used to show an associate's progress towards a specific rank.

    RankDetailGroup

    Provides the details of what an associate has to do for this rule group to be met.

    RankSummary

    Indicates the associate's progress towards this rank and each specific rule group.

    ReceiveLineInfo

    RedirectMoneyInMerchant

    This is one of the templates available for creating a custom money in merchant. With this merchant, when a customer places an order, they will be redirected to another site defined in PaymentResponse.RedirectURL where they will complete the payment.

    ReEntryRule

    ReEntryRuleType

    Refund

    Region

    RegionLocale

    RegionMapping

    RequestBase

    RetryRule

    RewardPointDetail

    Rma

    RmaLineItem

    Routing

    SaveCouponResponse

    The result of calling .

    SavedPaymentMoneyInMerchant

    This is one of the templates available for creating a custom money in merchant. Most of the time this merchant type is processing credit card payments.

    ShipMethod

    ShipPackage

    ShippingTaxOverride

    ShippingType

    SinglePaymentMoneyInMerchant

    This is one of the templates available for creating a custom money in merchant. Use this merchant to process payments without saved payment data.

    SocialInfo

    SourceOrder

    State

    StockAdjustment

    StockLevel

    Store

    StoreType

    Enumeration of store types. The values in this enumeration should correspond directly with what is in the INV_StoreType table

    Subscription

    SubscriptionAutoshipSettings

    SubscriptionItem

    SubscriptionPeriodType

    TaxLineItem

    TaxProvider

    TaxResult

    TaxResultDetail

    TaxResultItem

    TreeFullReEntryRule

    TreeType

    UpdateOrderInfo

    Information used to update an existing order.

    UpsertCouponResponse

    User

    Repersents a user that can log into the system.

    UsernameEditedMessage

    Class for representing the UsernameEdited event's message

    ValidationResult

    Used to return an error if something is invalid.

    VolumeSource

    Indicates an associate who's had volume change and who's stats will be recalculated.

    WebsiteInfo

    In This Article
    Back to top Copyright © 2022 DirectScale
    Generated by DocFX