@gr4vy/sdk 1.0.0-beta.21 → 1.0.0-beta.22

package/src/models/operations/gettransactionsummary.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+export type GetTransactionSummaryGlobals = {
+  merchantAccountId?: string | undefined;
+};
+
+export type GetTransactionSummaryRequest = {
+  /**
+   * The ID of the transaction
+   */
+  transactionId: string;
+  /**
+   * The ID of the merchant account to use for this request.
+   */
+  merchantAccountId?: string | null | undefined;
+};
+
+/** @internal */
+export const GetTransactionSummaryGlobals$inboundSchema: z.ZodType<
+  GetTransactionSummaryGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  merchantAccountId: z.string().optional(),
+});
+
+/** @internal */
+export type GetTransactionSummaryGlobals$Outbound = {
+  merchantAccountId?: string | undefined;
+};
+
+/** @internal */
+export const GetTransactionSummaryGlobals$outboundSchema: z.ZodType<
+  GetTransactionSummaryGlobals$Outbound,
+  z.ZodTypeDef,
+  GetTransactionSummaryGlobals
+> = z.object({
+  merchantAccountId: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetTransactionSummaryGlobals$ {
+  /** @deprecated use `GetTransactionSummaryGlobals$inboundSchema` instead. */
+  export const inboundSchema = GetTransactionSummaryGlobals$inboundSchema;
+  /** @deprecated use `GetTransactionSummaryGlobals$outboundSchema` instead. */
+  export const outboundSchema = GetTransactionSummaryGlobals$outboundSchema;
+  /** @deprecated use `GetTransactionSummaryGlobals$Outbound` instead. */
+  export type Outbound = GetTransactionSummaryGlobals$Outbound;
+}
+
+export function getTransactionSummaryGlobalsToJSON(
+  getTransactionSummaryGlobals: GetTransactionSummaryGlobals,
+): string {
+  return JSON.stringify(
+    GetTransactionSummaryGlobals$outboundSchema.parse(
+      getTransactionSummaryGlobals,
+    ),
+  );
+}
+
+export function getTransactionSummaryGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTransactionSummaryGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetTransactionSummaryGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTransactionSummaryGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetTransactionSummaryRequest$inboundSchema: z.ZodType<
+  GetTransactionSummaryRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction_id: z.string(),
+  merchantAccountId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "transaction_id": "transactionId",
+  });
+});
+
+/** @internal */
+export type GetTransactionSummaryRequest$Outbound = {
+  transaction_id: string;
+  merchantAccountId?: string | null | undefined;
+};
+
+/** @internal */
+export const GetTransactionSummaryRequest$outboundSchema: z.ZodType<
+  GetTransactionSummaryRequest$Outbound,
+  z.ZodTypeDef,
+  GetTransactionSummaryRequest
+> = z.object({
+  transactionId: z.string(),
+  merchantAccountId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    transactionId: "transaction_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetTransactionSummaryRequest$ {
+  /** @deprecated use `GetTransactionSummaryRequest$inboundSchema` instead. */
+  export const inboundSchema = GetTransactionSummaryRequest$inboundSchema;
+  /** @deprecated use `GetTransactionSummaryRequest$outboundSchema` instead. */
+  export const outboundSchema = GetTransactionSummaryRequest$outboundSchema;
+  /** @deprecated use `GetTransactionSummaryRequest$Outbound` instead. */
+  export type Outbound = GetTransactionSummaryRequest$Outbound;
+}
+
+export function getTransactionSummaryRequestToJSON(
+  getTransactionSummaryRequest: GetTransactionSummaryRequest,
+): string {
+  return JSON.stringify(
+    GetTransactionSummaryRequest$outboundSchema.parse(
+      getTransactionSummaryRequest,
+    ),
+  );
+}
+
+export function getTransactionSummaryRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTransactionSummaryRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetTransactionSummaryRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTransactionSummaryRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -52,6 +52,7 @@ export * from "./getreportexecution.js";
 export * from "./gettransaction.js";
 export * from "./gettransactionrefund.js";
 export * from "./gettransactionsettlement.js";
+export * from "./gettransactionsummary.js";
 export * from "./listallreportexecutions.js";
 export * from "./listauditlogs.js";
 export * from "./listbuyergiftcards.js";

package/src/sdk/transactions.ts

@@ -6,6 +6,7 @@ import { transactionsCapture } from "../funcs/transactionsCapture.js";
 import { transactionsCreate } from "../funcs/transactionsCreate.js";
 import { transactionsGet } from "../funcs/transactionsGet.js";
 import { transactionsList } from "../funcs/transactionsList.js";
+import { transactionsSummary } from "../funcs/transactionsSummary.js";
 import { transactionsSync } from "../funcs/transactionsSync.js";
 import { transactionsVoid } from "../funcs/transactionsVoid.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -132,6 +133,25 @@ export class Transactions extends ClientSDK {
     ));
   }
 
+  /**
+   * Get transaction summary
+   *
+   * @remarks
+   * Fetch a summary for a transaction.
+   */
+  async summary(
+    transactionId: string,
+    merchantAccountId?: string | null | undefined,
+    options?: RequestOptions,
+  ): Promise<components.TransactionStatusSummary> {
+    return unwrapAsync(transactionsSummary(
+      this,
+      transactionId,
+      merchantAccountId,
+      options,
+    ));
+  }
+
   /**
    * Sync transaction
    *