@gr4vy/sdk 2.3.20 → 2.3.22

package/src/funcs/transactionsRefundSettlementsGet.ts

@@ -0,0 +1,257 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { Gr4vyCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { Gr4vyError } from "../models/errors/gr4vyerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get transaction refund settlement
+ *
+ * @remarks
+ * Retrieve a specific refund settlement for a transaction by its unique identifier.
+ */
+export function transactionsRefundSettlementsGet(
+  client: Gr4vyCore,
+  transactionId: string,
+  settlementId: string,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.RefundSettlement,
+    | errors.Error400
+    | errors.Error401
+    | errors.Error403
+    | errors.Error404
+    | errors.Error405
+    | errors.Error409
+    | errors.HTTPValidationError
+    | errors.Error425
+    | errors.Error429
+    | errors.Error500
+    | errors.Error502
+    | errors.Error504
+    | Gr4vyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    transactionId,
+    settlementId,
+    merchantAccountId,
+    options,
+  ));
+}
+
+async function $do(
+  client: Gr4vyCore,
+  transactionId: string,
+  settlementId: string,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.RefundSettlement,
+      | errors.Error400
+      | errors.Error401
+      | errors.Error403
+      | errors.Error404
+      | errors.Error405
+      | errors.Error409
+      | errors.HTTPValidationError
+      | errors.Error425
+      | errors.Error429
+      | errors.Error500
+      | errors.Error502
+      | errors.Error504
+      | Gr4vyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.GetTransactionRefundSettlementRequest = {
+    transactionId: transactionId,
+    settlementId: settlementId,
+    merchantAccountId: merchantAccountId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.GetTransactionRefundSettlementRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    settlement_id: encodeSimple("settlement_id", payload.settlement_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    transaction_id: encodeSimple("transaction_id", payload.transaction_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/transactions/{transaction_id}/refund-settlements/{settlement_id}",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "x-gr4vy-merchant-account-id": encodeSimple(
+      "x-gr4vy-merchant-account-id",
+      payload.merchantAccountId ?? client._options.merchantAccountId,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "get_transaction_refund_settlement",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 200,
+          maxInterval: 200,
+          exponent: 1,
+          maxElapsedTime: 1000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.RefundSettlement,
+    | errors.Error400
+    | errors.Error401
+    | errors.Error403
+    | errors.Error404
+    | errors.Error405
+    | errors.Error409
+    | errors.HTTPValidationError
+    | errors.Error425
+    | errors.Error429
+    | errors.Error500
+    | errors.Error502
+    | errors.Error504
+    | Gr4vyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.RefundSettlement$inboundSchema),
+    M.jsonErr(400, errors.Error400$inboundSchema),
+    M.jsonErr(401, errors.Error401$inboundSchema),
+    M.jsonErr(403, errors.Error403$inboundSchema),
+    M.jsonErr(404, errors.Error404$inboundSchema),
+    M.jsonErr(405, errors.Error405$inboundSchema),
+    M.jsonErr(409, errors.Error409$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.jsonErr(425, errors.Error425$inboundSchema),
+    M.jsonErr(429, errors.Error429$inboundSchema),
+    M.jsonErr(500, errors.Error500$inboundSchema),
+    M.jsonErr(502, errors.Error502$inboundSchema),
+    M.jsonErr(504, errors.Error504$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/transactionsRefundSettlementsList.ts

@@ -0,0 +1,249 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { Gr4vyCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { Gr4vyError } from "../models/errors/gr4vyerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List transaction refund settlements
+ *
+ * @remarks
+ * List all refund settlements for a specific transaction.
+ */
+export function transactionsRefundSettlementsList(
+  client: Gr4vyCore,
+  transactionId: string,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.RefundSettlements,
+    | errors.Error400
+    | errors.Error401
+    | errors.Error403
+    | errors.Error404
+    | errors.Error405
+    | errors.Error409
+    | errors.HTTPValidationError
+    | errors.Error425
+    | errors.Error429
+    | errors.Error500
+    | errors.Error502
+    | errors.Error504
+    | Gr4vyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    transactionId,
+    merchantAccountId,
+    options,
+  ));
+}
+
+async function $do(
+  client: Gr4vyCore,
+  transactionId: string,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.RefundSettlements,
+      | errors.Error400
+      | errors.Error401
+      | errors.Error403
+      | errors.Error404
+      | errors.Error405
+      | errors.Error409
+      | errors.HTTPValidationError
+      | errors.Error425
+      | errors.Error429
+      | errors.Error500
+      | errors.Error502
+      | errors.Error504
+      | Gr4vyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.ListTransactionRefundSettlementsRequest = {
+    transactionId: transactionId,
+    merchantAccountId: merchantAccountId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.ListTransactionRefundSettlementsRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    transaction_id: encodeSimple("transaction_id", payload.transaction_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/transactions/{transaction_id}/refund-settlements")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "x-gr4vy-merchant-account-id": encodeSimple(
+      "x-gr4vy-merchant-account-id",
+      payload.merchantAccountId ?? client._options.merchantAccountId,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "list_transaction_refund_settlements",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 200,
+          maxInterval: 200,
+          exponent: 1,
+          maxElapsedTime: 1000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.RefundSettlements,
+    | errors.Error400
+    | errors.Error401
+    | errors.Error403
+    | errors.Error404
+    | errors.Error405
+    | errors.Error409
+    | errors.HTTPValidationError
+    | errors.Error425
+    | errors.Error429
+    | errors.Error500
+    | errors.Error502
+    | errors.Error504
+    | Gr4vyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.RefundSettlements$inboundSchema),
+    M.jsonErr(400, errors.Error400$inboundSchema),
+    M.jsonErr(401, errors.Error401$inboundSchema),
+    M.jsonErr(403, errors.Error403$inboundSchema),
+    M.jsonErr(404, errors.Error404$inboundSchema),
+    M.jsonErr(405, errors.Error405$inboundSchema),
+    M.jsonErr(409, errors.Error409$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.jsonErr(425, errors.Error425$inboundSchema),
+    M.jsonErr(429, errors.Error429$inboundSchema),
+    M.jsonErr(500, errors.Error500$inboundSchema),
+    M.jsonErr(502, errors.Error502$inboundSchema),
+    M.jsonErr(504, errors.Error504$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -77,7 +77,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "2.3.20",
-  genVersion: "2.916.4",
-  userAgent: "speakeasy-sdk/typescript 2.3.20 2.916.4 1.0.0 @gr4vy/sdk",
+  sdkVersion: "2.3.22",
+  genVersion: "2.918.1",
+  userAgent: "speakeasy-sdk/typescript 2.3.22 2.918.1 1.0.0 @gr4vy/sdk",
 } as const;

package/src/models/components/giftcarderrorcode.ts

@@ -31,6 +31,10 @@ export const GiftCardErrorCode = {
   ServiceNetworkError: "service_network_error",
   UnknownError: "unknown_error",
   MaxGiftCardsReached: "max_gift_cards_reached",
+  SuspectedFraud: "suspected_fraud",
+  CanceledPaymentMethod: "canceled_payment_method",
+  DuplicateTransaction: "duplicate_transaction",
+  UnexpectedState: "unexpected_state",
 } as const;
 /**
  * Gift card error codes.

package/src/models/components/index.ts

@@ -254,6 +254,8 @@ export * from "./recipient.js";
 export * from "./redirectpaymentmethodcreate.js";
 export * from "./refund.js";
 export * from "./refunds.js";
+export * from "./refundsettlement.js";
+export * from "./refundsettlements.js";
 export * from "./refundstatus.js";
 export * from "./refundtargettype.js";
 export * from "./report.js";

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`,
+  );
+}