Class protos.google.cloud.recaptchaenterprise.v1beta1.TransactionData (5.4.0)

Represents a TransactionData.

Package

@google-cloud/recaptcha-enterprise

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.recaptchaenterprise.v1beta1.ITransactionData);

Constructs a new TransactionData.

Parameter
NameDescription
properties ITransactionData

Properties to set

Properties

_transactionId

public _transactionId?: "transactionId";

TransactionData _transactionId.

billingAddress

public billingAddress?: (google.cloud.recaptchaenterprise.v1beta1.TransactionData.IAddress|null);

TransactionData billingAddress.

cardBin

public cardBin: string;

TransactionData cardBin.

cardLastFour

public cardLastFour: string;

TransactionData cardLastFour.

currencyCode

public currencyCode: string;

TransactionData currencyCode.

gatewayInfo

public gatewayInfo?: (google.cloud.recaptchaenterprise.v1beta1.TransactionData.IGatewayInfo|null);

TransactionData gatewayInfo.

items

public items: google.cloud.recaptchaenterprise.v1beta1.TransactionData.IItem[];

TransactionData items.

merchants

public merchants: google.cloud.recaptchaenterprise.v1beta1.TransactionData.IUser[];

TransactionData merchants.

paymentMethod

public paymentMethod: string;

TransactionData paymentMethod.

shippingAddress

public shippingAddress?: (google.cloud.recaptchaenterprise.v1beta1.TransactionData.IAddress|null);

TransactionData shippingAddress.

shippingValue

public shippingValue: number;

TransactionData shippingValue.

transactionId

public transactionId?: (string|null);

TransactionData transactionId.

user

public user?: (google.cloud.recaptchaenterprise.v1beta1.TransactionData.IUser|null);

TransactionData user.

value

public value: number;

TransactionData value.

Methods

create(properties)

public static create(properties?: google.cloud.recaptchaenterprise.v1beta1.ITransactionData): google.cloud.recaptchaenterprise.v1beta1.TransactionData;

Creates a new TransactionData instance using the specified properties.

Parameter
NameDescription
properties ITransactionData

Properties to set

Returns
TypeDescription
TransactionData

TransactionData instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.recaptchaenterprise.v1beta1.TransactionData;

Decodes a TransactionData message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
TransactionData

TransactionData

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.recaptchaenterprise.v1beta1.TransactionData;

Decodes a TransactionData message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
TransactionData

TransactionData

encode(message, writer)

public static encode(message: google.cloud.recaptchaenterprise.v1beta1.ITransactionData, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TransactionData message. Does not implicitly messages.

Parameters
NameDescription
message ITransactionData

TransactionData message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.recaptchaenterprise.v1beta1.ITransactionData, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TransactionData message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message ITransactionData

TransactionData message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.recaptchaenterprise.v1beta1.TransactionData;

Creates a TransactionData message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
TransactionData

TransactionData

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for TransactionData

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this TransactionData to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.recaptchaenterprise.v1beta1.TransactionData, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a TransactionData message. Also converts values to other types if specified.

Parameters
NameDescription
message TransactionData

TransactionData

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a TransactionData message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not