@gr4vy/sdk 2.3.21 → 2.3.23

package/src/models/components/refundsettlement.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * A settlement record for a refund on a transaction.
+ */
+export type RefundSettlement = {
+  /**
+   * The unique identifier for the record.
+   */
+  id: string;
+  /**
+   * The merchant account this record belongs to.
+   */
+  merchantAccountId: string;
+  /**
+   * The date and time the record was created, in ISO 8601 format.
+   */
+  createdAt: Date;
+  /**
+   * The date and time the record was last updated, in ISO 8601 format.
+   */
+  updatedAt: Date;
+  /**
+   * The date and time the record was posted, in ISO 8601 format.
+   */
+  postedAt: Date;
+  /**
+   * The date and time the record was ingested, in ISO 8601 format.
+   */
+  ingestedAt: Date;
+  /**
+   * ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * The total amount in the smallest currency unit (e.g. cents).
+   */
+  amount: number;
+  /**
+   * The exchange rate, if applicable.
+   */
+  exchangeRate?: number | null | undefined;
+  /**
+   * The commission amount deducted in the smallest currency unit.
+   */
+  commission: number;
+  /**
+   * The interchange fee, if applicable, in the smallest currency unit.
+   */
+  interchange?: number | null | undefined;
+  /**
+   * The markup fee, if applicable, in the smallest currency unit.
+   */
+  markup?: number | null | undefined;
+  /**
+   * The scheme fee, if applicable, in the smallest currency unit.
+   */
+  schemeFee?: number | null | undefined;
+  /**
+   * The report ID from the payment service.
+   */
+  paymentServiceReportId: string;
+  /**
+   * List of file IDs for the payment service report.
+   */
+  paymentServiceReportFileIds: Array<string>;
+  /**
+   * The transaction this record is associated with.
+   */
+  transactionId: string;
+  /**
+   * Always `refund-settlement`.
+   */
+  type: "refund-settlement";
+  /**
+   * The refund this settlement is associated with.
+   */
+  refundId: string;
+};
+
+/** @internal */
+export const RefundSettlement$inboundSchema: z.ZodType<
+  RefundSettlement,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  merchant_account_id: z.string(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  posted_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ingested_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  currency: z.string(),
+  amount: z.number().int(),
+  exchange_rate: z.nullable(z.number()).optional(),
+  commission: z.number().int(),
+  interchange: z.nullable(z.number().int()).optional(),
+  markup: z.nullable(z.number().int()).optional(),
+  scheme_fee: z.nullable(z.number().int()).optional(),
+  payment_service_report_id: z.string(),
+  payment_service_report_file_ids: z.array(z.string()),
+  transaction_id: z.string(),
+  type: z.literal("refund-settlement").default("refund-settlement"),
+  refund_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "merchant_account_id": "merchantAccountId",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+    "posted_at": "postedAt",
+    "ingested_at": "ingestedAt",
+    "exchange_rate": "exchangeRate",
+    "scheme_fee": "schemeFee",
+    "payment_service_report_id": "paymentServiceReportId",
+    "payment_service_report_file_ids": "paymentServiceReportFileIds",
+    "transaction_id": "transactionId",
+    "refund_id": "refundId",
+  });
+});
+
+export function refundSettlementFromJSON(
+  jsonString: string,
+): SafeParseResult<RefundSettlement, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RefundSettlement$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RefundSettlement' from JSON`,
+  );
+}

package/src/models/components/refundsettlements.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  RefundSettlement,
+  RefundSettlement$inboundSchema,
+} from "./refundsettlement.js";
+
+/**
+ * A list of settlement records for the refunds on a transaction.
+ */
+export type RefundSettlements = {
+  /**
+   * The list of refund settlement objects.
+   */
+  items: Array<RefundSettlement>;
+};
+
+/** @internal */
+export const RefundSettlements$inboundSchema: z.ZodType<
+  RefundSettlements,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(RefundSettlement$inboundSchema),
+});
+
+export function refundSettlementsFromJSON(
+  jsonString: string,
+): SafeParseResult<RefundSettlements, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RefundSettlements$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RefundSettlements' from JSON`,
+  );
+}

package/src/models/operations/gettransactionrefundsettlement.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type GetTransactionRefundSettlementGlobals = {
+  merchantAccountId?: string | undefined;
+};
+
+export type GetTransactionRefundSettlementRequest = {
+  /**
+   * The unique identifier of the transaction.
+   */
+  transactionId: string;
+  /**
+   * The unique identifier of the refund settlement.
+   */
+  settlementId: string;
+  /**
+   * The ID of the merchant account to use for this request.
+   */
+  merchantAccountId?: string | null | undefined;
+};
+
+/** @internal */
+export type GetTransactionRefundSettlementRequest$Outbound = {
+  transaction_id: string;
+  settlement_id: string;
+  merchantAccountId?: string | null | undefined;
+};
+
+/** @internal */
+export const GetTransactionRefundSettlementRequest$outboundSchema: z.ZodType<
+  GetTransactionRefundSettlementRequest$Outbound,
+  z.ZodTypeDef,
+  GetTransactionRefundSettlementRequest
+> = z.object({
+  transactionId: z.string(),
+  settlementId: z.string(),
+  merchantAccountId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    transactionId: "transaction_id",
+    settlementId: "settlement_id",
+  });
+});
+
+export function getTransactionRefundSettlementRequestToJSON(
+  getTransactionRefundSettlementRequest: GetTransactionRefundSettlementRequest,
+): string {
+  return JSON.stringify(
+    GetTransactionRefundSettlementRequest$outboundSchema.parse(
+      getTransactionRefundSettlementRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -64,6 +64,7 @@ export * from "./getthreedsscenario.js";
 export * from "./gettransaction.js";
 export * from "./gettransactioncapture.js";
 export * from "./gettransactionrefund.js";
+export * from "./gettransactionrefundsettlement.js";
 export * from "./gettransactionsettlement.js";
 export * from "./listallreportexecutions.js";
 export * from "./listapikeypairs.js";
@@ -92,6 +93,7 @@ export * from "./listtransactionactions.js";
 export * from "./listtransactioncaptures.js";
 export * from "./listtransactionevents.js";
 export * from "./listtransactionrefunds.js";
+export * from "./listtransactionrefundsettlements.js";
 export * from "./listtransactions.js";
 export * from "./listtransactionsettlements.js";
 export * from "./registerdigitalwalletdomain.js";

package/src/models/operations/listtransactionrefundsettlements.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type ListTransactionRefundSettlementsGlobals = {
+  merchantAccountId?: string | undefined;
+};
+
+export type ListTransactionRefundSettlementsRequest = {
+  /**
+   * The unique identifier of the transaction.
+   */
+  transactionId: string;
+  /**
+   * The ID of the merchant account to use for this request.
+   */
+  merchantAccountId?: string | null | undefined;
+};
+
+/** @internal */
+export type ListTransactionRefundSettlementsRequest$Outbound = {
+  transaction_id: string;
+  merchantAccountId?: string | null | undefined;
+};
+
+/** @internal */
+export const ListTransactionRefundSettlementsRequest$outboundSchema: z.ZodType<
+  ListTransactionRefundSettlementsRequest$Outbound,
+  z.ZodTypeDef,
+  ListTransactionRefundSettlementsRequest
+> = z.object({
+  transactionId: z.string(),
+  merchantAccountId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    transactionId: "transaction_id",
+  });
+});
+
+export function listTransactionRefundSettlementsRequestToJSON(
+  listTransactionRefundSettlementsRequest:
+    ListTransactionRefundSettlementsRequest,
+): string {
+  return JSON.stringify(
+    ListTransactionRefundSettlementsRequest$outboundSchema.parse(
+      listTransactionRefundSettlementsRequest,
+    ),
+  );
+}

package/src/sdk/refundsettlements.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionsRefundSettlementsGet } from "../funcs/transactionsRefundSettlementsGet.js";
+import { transactionsRefundSettlementsList } from "../funcs/transactionsRefundSettlementsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class RefundSettlements extends ClientSDK {
+  /**
+   * Get transaction refund settlement
+   *
+   * @remarks
+   * Retrieve a specific refund settlement for a transaction by its unique identifier.
+   */
+  async get(
+    transactionId: string,
+    settlementId: string,
+    merchantAccountId?: string | null | undefined,
+    options?: RequestOptions,
+  ): Promise<components.RefundSettlement> {
+    return unwrapAsync(transactionsRefundSettlementsGet(
+      this,
+      transactionId,
+      settlementId,
+      merchantAccountId,
+      options,
+    ));
+  }
+
+  /**
+   * List transaction refund settlements
+   *
+   * @remarks
+   * List all refund settlements for a specific transaction.
+   */
+  async list(
+    transactionId: string,
+    merchantAccountId?: string | null | undefined,
+    options?: RequestOptions,
+  ): Promise<components.RefundSettlements> {
+    return unwrapAsync(transactionsRefundSettlementsList(
+      this,
+      transactionId,
+      merchantAccountId,
+      options,
+    ));
+  }
+}

package/src/sdk/transactions.ts

@@ -19,6 +19,7 @@ import { Actions } from "./actions.js";
 import { Captures } from "./captures.js";
 import { Events } from "./events.js";
 import { Gr4vyRefunds } from "./gr4vyrefunds.js";
+import { RefundSettlements } from "./refundsettlements.js";
 import { Settlements } from "./settlements.js";
 
 export class Transactions extends ClientSDK {
@@ -42,6 +43,11 @@ export class Transactions extends ClientSDK {
     return (this._settlements ??= new Settlements(this._options));
   }
 
+  private _refundSettlements?: RefundSettlements;
+  get refundSettlements(): RefundSettlements {
+    return (this._refundSettlements ??= new RefundSettlements(this._options));
+  }
+
   private _captures?: Captures;
   get captures(): Captures {
     return (this._captures ??= new Captures(this._options));

package/models/components/apitypesdigitalwalletaddress.d.ts

@@ -1,14 +0,0 @@
-import * as z from "zod/v3";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-export type ApiTypesDigitalWalletAddress = {
-    line1: string;
-    line2: string | null;
-    city: string;
-    stateCode: string;
-    postalCode: string;
-};
-/** @internal */
-export declare const ApiTypesDigitalWalletAddress$inboundSchema: z.ZodType<ApiTypesDigitalWalletAddress, z.ZodTypeDef, unknown>;
-export declare function apiTypesDigitalWalletAddressFromJSON(jsonString: string): SafeParseResult<ApiTypesDigitalWalletAddress, SDKValidationError>;
-//# sourceMappingURL=apitypesdigitalwalletaddress.d.ts.map

package/models/components/apitypesdigitalwalletaddress.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"apitypesdigitalwalletaddress.d.ts","sourceRoot":"","sources":["../../src/models/components/apitypesdigitalwalletaddress.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,4BAA4B,GAAG;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,oCAAoC,CAClD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,4BAA4B,EAAE,kBAAkB,CAAC,CAMnE"}

package/models/components/apitypesdigitalwalletaddress.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"apitypesdigitalwalletaddress.js","sourceRoot":"","sources":["../../src/models/components/apitypesdigitalwalletaddress.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCH,oFAQC;AAxCD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AAYjD,gBAAgB;AACH,QAAA,0CAA0C,GAInD,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;CACxB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,YAAY,EAAE,WAAW;QACzB,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,oCAAoC,CAClD,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kDAA0C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtE,0DAA0D,CAC3D,CAAC;AACJ,CAAC"}

package/src/models/components/apitypesdigitalwalletaddress.ts

@@ -1,45 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-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 ApiTypesDigitalWalletAddress = {
-  line1: string;
-  line2: string | null;
-  city: string;
-  stateCode: string;
-  postalCode: string;
-};
-
-/** @internal */
-export const ApiTypesDigitalWalletAddress$inboundSchema: z.ZodType<
-  ApiTypesDigitalWalletAddress,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  line1: z.string(),
-  line2: z.nullable(z.string()),
-  city: z.string(),
-  state_code: z.string(),
-  postal_code: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    "state_code": "stateCode",
-    "postal_code": "postalCode",
-  });
-});
-
-export function apiTypesDigitalWalletAddressFromJSON(
-  jsonString: string,
-): SafeParseResult<ApiTypesDigitalWalletAddress, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ApiTypesDigitalWalletAddress$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ApiTypesDigitalWalletAddress' from JSON`,
-  );
-}