@gr4vy/sdk 2.2.0 → 2.2.1

package/src/funcs/transactionsCapturesGet.ts

@@ -0,0 +1,255 @@
+/*
+ * 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 capture
+ *
+ * @remarks
+ * Retrieve a specific capture for a transaction by its unique identifier.
+ */
+export function transactionsCapturesGet(
+  client: Gr4vyCore,
+  transactionId: string,
+  captureId: string,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.Capture,
+    | 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,
+    captureId,
+    merchantAccountId,
+    options,
+  ));
+}
+
+async function $do(
+  client: Gr4vyCore,
+  transactionId: string,
+  captureId: string,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.Capture,
+      | 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.GetTransactionCaptureRequest = {
+    transactionId: transactionId,
+    captureId: captureId,
+    merchantAccountId: merchantAccountId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.GetTransactionCaptureRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    capture_id: encodeSimple("capture_id", payload.capture_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    transaction_id: encodeSimple("transaction_id", payload.transaction_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/transactions/{transaction_id}/captures/{capture_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_capture",
+    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.Capture,
+    | 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.Capture$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/transactionsCapturesList.ts

@@ -0,0 +1,247 @@
+/*
+ * 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 captures
+ *
+ * @remarks
+ * List all captures for a specific transaction.
+ */
+export function transactionsCapturesList(
+  client: Gr4vyCore,
+  transactionId: string,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.CaptureCollection,
+    | 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.CaptureCollection,
+      | 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.ListTransactionCapturesRequest = {
+    transactionId: transactionId,
+    merchantAccountId: merchantAccountId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.ListTransactionCapturesRequest$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}/captures")(
+    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_captures",
+    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.CaptureCollection,
+    | 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.CaptureCollection$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.2.0",
+  sdkVersion: "2.2.1",
   genVersion: "2.900.1",
-  userAgent: "speakeasy-sdk/typescript 2.2.0 2.900.1 1.0.0 @gr4vy/sdk",
+  userAgent: "speakeasy-sdk/typescript 2.2.1 2.900.1 1.0.0 @gr4vy/sdk",
 } as const;

package/src/models/components/capture.ts

@@ -0,0 +1,142 @@
+/*
+ * 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";
+import { CaptureStatus, CaptureStatus$inboundSchema } from "./capturestatus.js";
+import { CartItem, CartItem$inboundSchema } from "./cartitem.js";
+
+export type Capture = {
+  /**
+   * Always `capture`.
+   */
+  type: "capture";
+  /**
+   * The unique identifier for the capture.
+   */
+  id: string;
+  /**
+   * The merchant account this capture belongs to.
+   */
+  merchantAccountId: string;
+  /**
+   * The ID of the transaction associated with this capture.
+   */
+  transactionId: string;
+  /**
+   * The payment service's unique ID for the capture.
+   */
+  xid?: string | null | undefined;
+  /**
+   * The ISO 4217 currency code for this capture.
+   */
+  currency: string;
+  /**
+   * The capture amount in the smallest currency unit.
+   */
+  amount: number;
+  status: CaptureStatus;
+  /**
+   * Whether this is marked as the final capture for the associated transaction.
+   */
+  final: boolean;
+  /**
+   * The date and time this capture was created.
+   */
+  createdAt: Date;
+  /**
+   * The date and time this capture was last updated.
+   */
+  updatedAt: Date;
+  /**
+   * The date and time the capture was completed.
+   */
+  capturedAt?: Date | null | undefined;
+  /**
+   * An external identifier that can be used to match the capture against your own records.
+   */
+  externalIdentifier?: string | null | undefined;
+  /**
+   * The standardized error code set by Gr4vy.
+   */
+  errorCode?: string | null | undefined;
+  /**
+   * The ISO response code.
+   */
+  isoResponseCode?: string | null | undefined;
+  /**
+   * 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 | undefined;
+  /**
+   * 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.
+   */
+  rawResponseDescription?: string | null | undefined;
+  /**
+   * The external identifier of the associated transaction.
+   */
+  transactionExternalIdentifier?: string | null | undefined;
+  /**
+   * An array of cart items that represents the line items of this capture.
+   */
+  cartItems?: Array<CartItem> | null | undefined;
+};
+
+/** @internal */
+export const Capture$inboundSchema: z.ZodType<Capture, z.ZodTypeDef, unknown> =
+  z.object({
+    type: z.literal("capture").default("capture"),
+    id: z.string(),
+    merchant_account_id: z.string(),
+    transaction_id: z.string(),
+    xid: z.nullable(z.string()).optional(),
+    currency: z.string(),
+    amount: z.number().int(),
+    status: CaptureStatus$inboundSchema,
+    final: z.boolean(),
+    created_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    updated_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    captured_at: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    external_identifier: z.nullable(z.string()).optional(),
+    error_code: z.nullable(z.string()).optional(),
+    iso_response_code: z.nullable(z.string()).optional(),
+    raw_response_code: z.nullable(z.string()).optional(),
+    raw_response_description: z.nullable(z.string()).optional(),
+    transaction_external_identifier: z.nullable(z.string()).optional(),
+    cart_items: z.nullable(z.array(CartItem$inboundSchema)).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "merchant_account_id": "merchantAccountId",
+      "transaction_id": "transactionId",
+      "created_at": "createdAt",
+      "updated_at": "updatedAt",
+      "captured_at": "capturedAt",
+      "external_identifier": "externalIdentifier",
+      "error_code": "errorCode",
+      "iso_response_code": "isoResponseCode",
+      "raw_response_code": "rawResponseCode",
+      "raw_response_description": "rawResponseDescription",
+      "transaction_external_identifier": "transactionExternalIdentifier",
+      "cart_items": "cartItems",
+    });
+  });
+
+export function captureFromJSON(
+  jsonString: string,
+): SafeParseResult<Capture, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Capture$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Capture' from JSON`,
+  );
+}

package/src/models/components/capturecollection.ts

@@ -0,0 +1,56 @@
+/*
+ * 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";
+import { Capture, Capture$inboundSchema } from "./capture.js";
+
+export type CaptureCollection = {
+  /**
+   * A list of items returned for this request.
+   */
+  items: Array<Capture>;
+  /**
+   * The number of items for this page.
+   */
+  limit: number;
+  /**
+   * The cursor pointing at the next page of items.
+   */
+  nextCursor?: string | null | undefined;
+  /**
+   * The cursor pointing at the previous page of items.
+   */
+  previousCursor?: string | null | undefined;
+};
+
+/** @internal */
+export const CaptureCollection$inboundSchema: z.ZodType<
+  CaptureCollection,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(Capture$inboundSchema),
+  limit: z.number().int().default(20),
+  next_cursor: z.nullable(z.string()).optional(),
+  previous_cursor: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "next_cursor": "nextCursor",
+    "previous_cursor": "previousCursor",
+  });
+});
+
+export function captureCollectionFromJSON(
+  jsonString: string,
+): SafeParseResult<CaptureCollection, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CaptureCollection$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CaptureCollection' from JSON`,
+  );
+}