• Articles
  • Api Documentation

    Show / Hide Table of Contents
    • Yort.Humm.InStore
      • CreateKeyRequest
      • CreateKeyResponse
      • HummApiUrlSelector
      • HummClient
      • HummClientConfiguration
      • HummCountry
      • HummEnvironment
      • HummResponseSignatureException
      • HummStatusCodes
      • IHummApiUrlSelector
      • IHummClient
      • InviteRequest
      • InviteResponse
      • PendingAuthorisationEventArgs
      • ProcessAuthorisationRequest
      • ProcessAuthorisationResponse
      • ProcessSalesAdjustmentRequest
      • ProcessSalesAdjustmentResponse
      • ProcessSalesAdjustmentReversalRequest
      • ProcessSalesAdjustmentReversalResponse
      • PurchaseItemsCollection
      • RequestStates
      • SendReceiptRequest
      • SendReceiptResponse
    • Yort.Humm.InStore.Infrastructure
      • Hmac256SignatureGenerator
      • ISignatureGenerator
      • RequestBase
      • ResponseBase
      • SignedRequestWriter

    Class InviteRequest

    Represents a request to send an SMS to a mobile phone number inviting someone to sign up to Humm.

    Inheritance
    Object
    RequestBase
    InviteRequest
    Inherited Members
    RequestBase.MerchantId
    RequestBase.DeviceId
    RequestBase.PosVersion
    RequestBase.OperatorId
    RequestBase.TrackingData
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Yort.Humm.InStore
    Assembly: Yort.Humm.InStore.dll
    Syntax
    public sealed class InviteRequest : RequestBase

    Properties

    | Improve this Doc View Source

    MobileNumber

    Required. Gets or sets the mobile number to send the invitation to.

    Declaration
    [JsonProperty("x_mobile")]
    public string MobileNumber { get; set; }
    Property Value
    Type Description
    String

    The mobile phone number.

    Remarks

    Maximum length of 10 digits.

    | Improve this Doc View Source

    PurchaseAmount

    Gets or sets the amount of a initial purchase amount to generate a pre-approval code for after sign-up is complete.

    Declaration
    [JsonProperty("x_purchase_amount")]
    public decimal PurchaseAmount { get; set; }
    Property Value
    Type Description
    Decimal

    The purchase amount as a dollar value (i.e $20 would be 20.00).

    Methods

    | Improve this Doc View Source

    Validate()

    Validates this instance.

    Declaration
    public override void Validate()
    Overrides
    RequestBase.Validate()
    Remarks

    Ensures that MobileNumber is not null, empty string or only whitespace. Also ensure no property is larger than it's maximum allowed length (see individual property notes for details). Also ensures all base properties are valid, see Validate().

    See Also

    RequestBase
    InviteAsync(InviteRequest)
    InviteResponse
    • Improve this Doc
    • View Source
    Back to top Copyright (c) 2020 Troy Willmot