@gr4vy/sdk 1.1.12 → 1.1.14

package/src/models/components/transactioncapture.ts

@@ -3,28 +3,44 @@
  */
 
 import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  Airline,
-  Airline$inboundSchema,
-  Airline$Outbound,
-  Airline$outboundSchema,
-} from "./airline.js";
+  CaptureStatus,
+  CaptureStatus$inboundSchema,
+  CaptureStatus$outboundSchema,
+} from "./capturestatus.js";
+import {
+  Transaction,
+  Transaction$inboundSchema,
+  Transaction$Outbound,
+  Transaction$outboundSchema,
+} from "./transaction.js";
 
-/**
- * Request body for capturing an authorized transaction.
- */
 export type TransactionCapture = {
   /**
-   * The amount to capture, in the smallest currency unit (e.g., cents). This must be less than or equal to the authorized amount, unless over-capture is available.
+   * Always `transaction-capture`.
+   */
+  type?: "transaction-capture" | undefined;
+  status: CaptureStatus;
+  /**
+   * The standardized error code set by Gr4vy.
+   */
+  code: string | null;
+  /**
+   * This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.
+   */
+  rawResponseCode: string | null;
+  /**
+   * This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.
    */
-  amount?: number | null | undefined;
+  rawResponseDescription: string | null;
   /**
-   * The airline data to submit to the payment service during the capture call.
+   * A full transaction resource.
    */
-  airline?: Airline | null | undefined;
+  transaction: Transaction;
 };
 
 /** @internal */
@@ -33,14 +49,27 @@ export const TransactionCapture$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  amount: z.nullable(z.number().int()).optional(),
-  airline: z.nullable(Airline$inboundSchema).optional(),
+  type: z.literal("transaction-capture").default("transaction-capture"),
+  status: CaptureStatus$inboundSchema,
+  code: z.nullable(z.string()),
+  raw_response_code: z.nullable(z.string()),
+  raw_response_description: z.nullable(z.string()),
+  transaction: Transaction$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "raw_response_code": "rawResponseCode",
+    "raw_response_description": "rawResponseDescription",
+  });
 });
 
 /** @internal */
 export type TransactionCapture$Outbound = {
-  amount?: number | null | undefined;
-  airline?: Airline$Outbound | null | undefined;
+  type: "transaction-capture";
+  status: string;
+  code: string | null;
+  raw_response_code: string | null;
+  raw_response_description: string | null;
+  transaction: Transaction$Outbound;
 };
 
 /** @internal */
@@ -49,8 +78,19 @@ export const TransactionCapture$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TransactionCapture
 > = z.object({
-  amount: z.nullable(z.number().int()).optional(),
-  airline: z.nullable(Airline$outboundSchema).optional(),
+  type: z.literal("transaction-capture").default(
+    "transaction-capture" as const,
+  ),
+  status: CaptureStatus$outboundSchema,
+  code: z.nullable(z.string()),
+  rawResponseCode: z.nullable(z.string()),
+  rawResponseDescription: z.nullable(z.string()),
+  transaction: Transaction$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    rawResponseCode: "raw_response_code",
+    rawResponseDescription: "raw_response_description",
+  });
 });
 
 /**

package/src/models/components/transactioncapturecreate.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Airline,
+  Airline$inboundSchema,
+  Airline$Outbound,
+  Airline$outboundSchema,
+} from "./airline.js";
+
+/**
+ * Request body for capturing an authorized transaction.
+ */
+export type TransactionCaptureCreate = {
+  /**
+   * The amount to capture, in the smallest currency unit (e.g., cents). This must be less than or equal to the authorized amount, unless over-capture is available.
+   */
+  amount?: number | null | undefined;
+  /**
+   * The airline data to submit to the payment service during the capture call.
+   */
+  airline?: Airline | null | undefined;
+};
+
+/** @internal */
+export const TransactionCaptureCreate$inboundSchema: z.ZodType<
+  TransactionCaptureCreate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.nullable(z.number().int()).optional(),
+  airline: z.nullable(Airline$inboundSchema).optional(),
+});
+
+/** @internal */
+export type TransactionCaptureCreate$Outbound = {
+  amount?: number | null | undefined;
+  airline?: Airline$Outbound | null | undefined;
+};
+
+/** @internal */
+export const TransactionCaptureCreate$outboundSchema: z.ZodType<
+  TransactionCaptureCreate$Outbound,
+  z.ZodTypeDef,
+  TransactionCaptureCreate
+> = z.object({
+  amount: z.nullable(z.number().int()).optional(),
+  airline: z.nullable(Airline$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TransactionCaptureCreate$ {
+  /** @deprecated use `TransactionCaptureCreate$inboundSchema` instead. */
+  export const inboundSchema = TransactionCaptureCreate$inboundSchema;
+  /** @deprecated use `TransactionCaptureCreate$outboundSchema` instead. */
+  export const outboundSchema = TransactionCaptureCreate$outboundSchema;
+  /** @deprecated use `TransactionCaptureCreate$Outbound` instead. */
+  export type Outbound = TransactionCaptureCreate$Outbound;
+}
+
+export function transactionCaptureCreateToJSON(
+  transactionCaptureCreate: TransactionCaptureCreate,
+): string {
+  return JSON.stringify(
+    TransactionCaptureCreate$outboundSchema.parse(transactionCaptureCreate),
+  );
+}
+
+export function transactionCaptureCreateFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionCaptureCreate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionCaptureCreate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionCaptureCreate' from JSON`,
+  );
+}

package/src/models/operations/capturetransaction.ts

@@ -18,13 +18,24 @@ export type CaptureTransactionRequest = {
    * The ID of the transaction
    */
   transactionId: string;
+  /**
+   * The preferred resource type in the response.
+   */
+  prefer?: string | null | undefined;
   /**
    * The ID of the merchant account to use for this request.
    */
   merchantAccountId?: string | null | undefined;
-  transactionCapture: components.TransactionCapture;
+  transactionCaptureCreate: components.TransactionCaptureCreate;
 };
 
+/**
+ * Successful Response
+ */
+export type CaptureTransactionResponseCaptureTransaction =
+  | components.Transaction
+  | components.TransactionCapture;
+
 /** @internal */
 export const CaptureTransactionGlobals$inboundSchema: z.ZodType<
   CaptureTransactionGlobals,
@@ -86,20 +97,22 @@ export const CaptureTransactionRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   transaction_id: z.string(),
+  prefer: z.nullable(z.string()).optional(),
   merchantAccountId: z.nullable(z.string()).optional(),
-  TransactionCapture: components.TransactionCapture$inboundSchema,
+  TransactionCaptureCreate: components.TransactionCaptureCreate$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "transaction_id": "transactionId",
-    "TransactionCapture": "transactionCapture",
+    "TransactionCaptureCreate": "transactionCaptureCreate",
   });
 });
 
 /** @internal */
 export type CaptureTransactionRequest$Outbound = {
   transaction_id: string;
+  prefer?: string | null | undefined;
   merchantAccountId?: string | null | undefined;
-  TransactionCapture: components.TransactionCapture$Outbound;
+  TransactionCaptureCreate: components.TransactionCaptureCreate$Outbound;
 };
 
 /** @internal */
@@ -109,12 +122,13 @@ export const CaptureTransactionRequest$outboundSchema: z.ZodType<
   CaptureTransactionRequest
 > = z.object({
   transactionId: z.string(),
+  prefer: z.nullable(z.string()).optional(),
   merchantAccountId: z.nullable(z.string()).optional(),
-  transactionCapture: components.TransactionCapture$outboundSchema,
+  transactionCaptureCreate: components.TransactionCaptureCreate$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     transactionId: "transaction_id",
-    transactionCapture: "TransactionCapture",
+    transactionCaptureCreate: "TransactionCaptureCreate",
   });
 });
 
@@ -148,3 +162,72 @@ export function captureTransactionRequestFromJSON(
     `Failed to parse 'CaptureTransactionRequest' from JSON`,
   );
 }
+
+/** @internal */
+export const CaptureTransactionResponseCaptureTransaction$inboundSchema:
+  z.ZodType<
+    CaptureTransactionResponseCaptureTransaction,
+    z.ZodTypeDef,
+    unknown
+  > = z.union([
+    components.Transaction$inboundSchema,
+    components.TransactionCapture$inboundSchema,
+  ]);
+
+/** @internal */
+export type CaptureTransactionResponseCaptureTransaction$Outbound =
+  | components.Transaction$Outbound
+  | components.TransactionCapture$Outbound;
+
+/** @internal */
+export const CaptureTransactionResponseCaptureTransaction$outboundSchema:
+  z.ZodType<
+    CaptureTransactionResponseCaptureTransaction$Outbound,
+    z.ZodTypeDef,
+    CaptureTransactionResponseCaptureTransaction
+  > = z.union([
+    components.Transaction$outboundSchema,
+    components.TransactionCapture$outboundSchema,
+  ]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CaptureTransactionResponseCaptureTransaction$ {
+  /** @deprecated use `CaptureTransactionResponseCaptureTransaction$inboundSchema` instead. */
+  export const inboundSchema =
+    CaptureTransactionResponseCaptureTransaction$inboundSchema;
+  /** @deprecated use `CaptureTransactionResponseCaptureTransaction$outboundSchema` instead. */
+  export const outboundSchema =
+    CaptureTransactionResponseCaptureTransaction$outboundSchema;
+  /** @deprecated use `CaptureTransactionResponseCaptureTransaction$Outbound` instead. */
+  export type Outbound = CaptureTransactionResponseCaptureTransaction$Outbound;
+}
+
+export function captureTransactionResponseCaptureTransactionToJSON(
+  captureTransactionResponseCaptureTransaction:
+    CaptureTransactionResponseCaptureTransaction,
+): string {
+  return JSON.stringify(
+    CaptureTransactionResponseCaptureTransaction$outboundSchema.parse(
+      captureTransactionResponseCaptureTransaction,
+    ),
+  );
+}
+
+export function captureTransactionResponseCaptureTransactionFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CaptureTransactionResponseCaptureTransaction,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CaptureTransactionResponseCaptureTransaction$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CaptureTransactionResponseCaptureTransaction' from JSON`,
+  );
+}

package/src/sdk/paymentservicedefinitions.ts

@@ -54,7 +54,7 @@ export class PaymentServiceDefinitions extends ClientSDK {
   }
 
   /**
-   * Create a session for apayment service definition
+   * Create a session for a payment service definition
    *
    * @remarks
    * Creates a session for a payment service that supports sessions.

package/src/sdk/paymentservices.ts

@@ -133,7 +133,7 @@ export class PaymentServices extends ClientSDK {
   }
 
   /**
-   * Create a session for apayment service definition
+   * Create a session for a payment service definition
    *
    * @remarks
    * Creates a session for a payment service that supports sessions.

package/src/sdk/transactions.ts

@@ -123,15 +123,17 @@ export class Transactions extends ClientSDK {
    * Captures a previously authorized transaction. You can capture the full or a partial amount, as long as it does not exceed the authorized amount (unless over-capture is enabled).
    */
   async capture(
-    transactionCapture: components.TransactionCapture,
+    transactionCaptureCreate: components.TransactionCaptureCreate,
     transactionId: string,
+    prefer?: string | null | undefined,
     merchantAccountId?: string | null | undefined,
     options?: RequestOptions,
-  ): Promise<components.Transaction> {
+  ): Promise<operations.CaptureTransactionResponseCaptureTransaction> {
     return unwrapAsync(transactionsCapture(
       this,
-      transactionCapture,
+      transactionCaptureCreate,
       transactionId,
+      prefer,
       merchantAccountId,
       options,
     ));