@compassdigital/sdk.typescript 4.658.0 → 4.660.0

package/src/index.ts

@@ -3,8 +3,14 @@
 import {
 	PostPaymentTransactionBody,
 	PostPaymentTransactionResponse,
+	PostPaymentTransactionAuthBody,
+	PostPaymentTransactionAuthResponse,
 	PostPaymentTransactionRefundBody,
 	PostPaymentTransactionRefundResponse,
+	PostPaymentTransactionCaptureBody,
+	PostPaymentTransactionCaptureResponse,
+	PostPaymentTransactionVoidBody,
+	PostPaymentTransactionVoidResponse,
 	GetPaymentClienttokenQuery,
 	GetPaymentClienttokenResponse,
 	PostPaymentPaymenttokenBody,
@@ -1597,6 +1603,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /payment/{id}/transaction/auth - This endpoint is used to only authorize a transaction. It will not charge the transaction.
+	 *
+	 * @param id - Payment ID
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_payment_transaction_auth(
+		id: string,
+		body: PostPaymentTransactionAuthBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostPaymentTransactionAuthResponse> {
+		return this.request(
+			'payment',
+			'/payment/{id}/transaction/auth',
+			'POST',
+			`/payment/${id}/transaction/auth`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /payment/{id}/transaction/{transaction_id}/refund
 	 *
@@ -1621,6 +1649,50 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /payment/{id}/transaction/capture - This endpoint is used to capture a transaction that has been authorized already. So there won't be second authorization.
+	 *
+	 * @param id - Payment ID
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_payment_transaction_capture(
+		id: string,
+		body: PostPaymentTransactionCaptureBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostPaymentTransactionCaptureResponse> {
+		return this.request(
+			'payment',
+			'/payment/{id}/transaction/capture',
+			'POST',
+			`/payment/${id}/transaction/capture`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /payment/{id}/transaction/void - This endpoint is used to void a transaction that has been authorized already.So user's auth will be voided faster instead of waiting for the auth to expire.
+	 *
+	 * @param id - Payment ID
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_payment_transaction_void(
+		id: string,
+		body: PostPaymentTransactionVoidBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostPaymentTransactionVoidResponse> {
+		return this.request(
+			'payment',
+			'/payment/{id}/transaction/void',
+			'POST',
+			`/payment/${id}/transaction/void`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /payment/{id}/clienttoken
 	 *

package/src/interface/consumer.ts

@@ -2285,6 +2285,8 @@ export interface GetMenuItemNutrientConsumerV2 {
 	key: string;
 	// Indent level for FDA label layout (0 = primary, 1 = sub-nutrient, 2 = sub-sub-nutrient)
 	indent: number;
+	// Numeric amount
+	amount?: number;
 	// Unit of measurement
 	unit?: string;
 	// Formatted display value (e.g. "8 g")

package/src/interface/payment.ts

@@ -267,6 +267,46 @@ export interface PostPaymentTransactionRequest extends BaseRequest, PostPaymentT
 	body: PostPaymentTransactionBody;
 }
 
+// POST /payment/{id}/transaction/auth - This endpoint is used to only authorize a transaction. It will not charge the transaction.
+
+export interface PostPaymentTransactionAuthPath {
+	// Payment ID
+	id: string;
+}
+
+export interface PostPaymentTransactionAuthBody {
+	// The payment method token to use for the payment
+	payment_method_token?: string;
+	// The amount to charge to the payment method
+	amount: string;
+	options?: Options;
+	// The braintree merchant account id to use
+	merchant_account_id?: string;
+	digital_wallet_token?: string;
+	account_number?: string;
+	cv_number?: string;
+	expiration_month?: number;
+	expiration_year?: number;
+	cart_items?: {
+		id?: string;
+		label?: {
+			en?: string;
+		};
+		price?: {
+			amount?: number;
+		};
+		quantity?: number;
+	}[];
+}
+
+export type PostPaymentTransactionAuthResponse = Transaction;
+
+export interface PostPaymentTransactionAuthRequest
+	extends BaseRequest,
+		PostPaymentTransactionAuthPath {
+	body: PostPaymentTransactionAuthBody;
+}
+
 // POST /payment/{id}/transaction/{transaction_id}/refund
 
 export interface PostPaymentTransactionRefundPath {
@@ -291,6 +331,66 @@ export interface PostPaymentTransactionRefundRequest
 	body: PostPaymentTransactionRefundBody;
 }
 
+// POST /payment/{id}/transaction/capture - This endpoint is used to capture a transaction that has been authorized already. So there won't be second authorization.
+
+export interface PostPaymentTransactionCapturePath {
+	// Payment ID
+	id: string;
+}
+
+export interface PostPaymentTransactionCaptureBody {
+	// FreedomPay request ID from the original authorization
+	requestID: string;
+	// The amount to capture
+	amount: string;
+	// The payment method token from the original authorization
+	payment_method_token?: string;
+	options?: Options;
+	digital_wallet_token?: string;
+	cart_items?: {
+		id?: string;
+		label?: {
+			en?: string;
+		};
+		price?: {
+			amount?: number;
+		};
+		quantity?: number;
+	}[];
+}
+
+export type PostPaymentTransactionCaptureResponse = Transaction;
+
+export interface PostPaymentTransactionCaptureRequest
+	extends BaseRequest,
+		PostPaymentTransactionCapturePath {
+	body: PostPaymentTransactionCaptureBody;
+}
+
+// POST /payment/{id}/transaction/void - This endpoint is used to void a transaction that has been authorized already.So user's auth will be voided faster instead of waiting for the auth to expire.
+
+export interface PostPaymentTransactionVoidPath {
+	// Payment ID
+	id: string;
+}
+
+export interface PostPaymentTransactionVoidBody {
+	// FreedomPay request ID from the original authorization
+	requestID: string;
+	// Brand/site ID for FreedomPay credentials
+	brand?: string;
+	// Location ID for FreedomPay credentials
+	location?: string;
+}
+
+export type PostPaymentTransactionVoidResponse = Transaction;
+
+export interface PostPaymentTransactionVoidRequest
+	extends BaseRequest,
+		PostPaymentTransactionVoidPath {
+	body: PostPaymentTransactionVoidBody;
+}
+
 // GET /payment/{id}/clienttoken
 
 export interface GetPaymentClienttokenPath {