• Articles
  • Api Documentation

    Show / Hide Table of Contents
    • Yort.Laybuy.InStore
      • CancelOrderRequest
      • CancelOrderResponse
      • CreateOrderRequest
      • CreateOrderResponse
      • ILaybuyClient
      • LaybuyApiException
      • LaybuyApiResponseBase
      • LaybuyClient
      • LaybuyClientConfiguration
      • LaybuyCredentials
      • LaybuyCustomerAddress
      • LaybuyCustomerBase
      • LaybuyEnvironment
      • LaybuyItem
      • LaybuyOrderRefund
      • LaybuyOrderStatus
      • LaybuyRequestBase
      • LaybuyStatus
      • OrderRequest
      • OrderResponse
      • OrderStatusRequest
      • OrderStatusResponse
      • RefundRequest
      • RefundResponse
      • RequestLaybuyCustomer
      • ResponseLaybuyCustomer
      • StandardOriginData

    Class LaybuyClientConfiguration

    Provides configuration settings for ILaybuyClient and default values for some requests..

    Inheritance
    Object
    LaybuyClientConfiguration
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Yort.Laybuy.InStore
    Assembly: Yort.Laybuy.InStore.dll
    Syntax
    public class LaybuyClientConfiguration

    Constructors

    | Improve this Doc View Source

    LaybuyClientConfiguration(LaybuyCredentials)

    Default constructor.

    Declaration
    public LaybuyClientConfiguration(LaybuyCredentials credentials)
    Parameters
    Type Name Description
    LaybuyCredentials credentials

    Properties

    | Improve this Doc View Source

    Credentials

    Gets or sets a LaybuyCredentials instance used to authenticate to the Laybuy API.

    Declaration
    public LaybuyCredentials Credentials { get; }
    Property Value
    Type Description
    LaybuyCredentials
    | Improve this Doc View Source

    DefaultBranch

    Gets or sets the default value for Branch which is applied if no origin data is specified on a CreateOrderRequest.

    Declaration
    public string DefaultBranch { get; set; }
    Property Value
    Type Description
    String

    The default branch identifier (usually name).

    | Improve this Doc View Source

    DefaultOrigin

    Gets or sets the default Origin value.

    Declaration
    public string DefaultOrigin { get; set; }
    Property Value
    Type Description
    String

    The default origin.

    Remarks

    The default value is "POS".

    | Improve this Doc View Source

    Environment

    Gets or sets a value from the LaybuyEnvironment enum specifying whether this client connects to the production or sandboxed (test) Laybuy API.

    Declaration
    public LaybuyEnvironment Environment { get; set; }
    Property Value
    Type Description
    LaybuyEnvironment
    Remarks

    The default value is Sandbox to prevent accidental live transactions. Production systems must specify Production for real payments to occur.

    | Improve this Doc View Source

    HttpClientFactory

    Gets or sets a function that create an HttpClient to be used to communicate with Laybuy. Can be null, in which case the system will create it's own instance.

    Declaration
    public Func<HttpClient> HttpClientFactory { get; set; }
    Property Value
    Type Description
    Func<HttpClient>
    • Improve this Doc
    • View Source
    Back to top Copyright (c) 2020 Troy Willmot