@gr4vy/sdk 1.1.38 → 1.1.40

package/src/funcs/transactionsCancel.ts

@@ -0,0 +1,248 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { Gr4vyCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.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";
+
+/**
+ * Cancel transaction
+ *
+ * @remarks
+ * Cancels a pending transaction. If the transaction was successfully authorized, or was already captured, the cancel will not be processed.
+ */
+export function transactionsCancel(
+  client: Gr4vyCore,
+  transactionId: string,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TransactionCancel,
+    | 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.TransactionCancel,
+      | 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.CancelTransactionRequest = {
+    transactionId: transactionId,
+    merchantAccountId: merchantAccountId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) => operations.CancelTransactionRequest$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}/cancel")(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: "cancel_transaction",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    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,
+    errorCodes: [
+      "400",
+      "401",
+      "403",
+      "404",
+      "405",
+      "409",
+      "422",
+      "425",
+      "429",
+      "4XX",
+      "500",
+      "502",
+      "504",
+      "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.TransactionCancel,
+    | 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.TransactionCancel$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: "1.1.38",
-  genVersion: "2.686.7",
-  userAgent: "speakeasy-sdk/typescript 1.1.38 2.686.7 1.0.0 @gr4vy/sdk",
+  sdkVersion: "1.1.40",
+  genVersion: "2.690.1",
+  userAgent: "speakeasy-sdk/typescript 1.1.40 2.690.1 1.0.0 @gr4vy/sdk",
 } as const;

package/src/models/components/cancelstatus.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  catchUnrecognizedEnum,
+  OpenEnum,
+  Unrecognized,
+} from "../../types/enums.js";
+
+export const CancelStatus = {
+  Succeeded: "succeeded",
+  Pending: "pending",
+  Failed: "failed",
+} as const;
+export type CancelStatus = OpenEnum<typeof CancelStatus>;
+
+/** @internal */
+export const CancelStatus$inboundSchema: z.ZodType<
+  CancelStatus,
+  z.ZodTypeDef,
+  unknown
+> = z
+  .union([
+    z.nativeEnum(CancelStatus),
+    z.string().transform(catchUnrecognizedEnum),
+  ]);
+
+/** @internal */
+export const CancelStatus$outboundSchema: z.ZodType<
+  CancelStatus,
+  z.ZodTypeDef,
+  CancelStatus
+> = z.union([
+  z.nativeEnum(CancelStatus),
+  z.string().and(z.custom<Unrecognized<string>>()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CancelStatus$ {
+  /** @deprecated use `CancelStatus$inboundSchema` instead. */
+  export const inboundSchema = CancelStatus$inboundSchema;
+  /** @deprecated use `CancelStatus$outboundSchema` instead. */
+  export const outboundSchema = CancelStatus$outboundSchema;
+}

package/src/models/components/index.ts

@@ -38,6 +38,7 @@ export * from "./buyer.js";
 export * from "./buyercreate.js";
 export * from "./buyers.js";
 export * from "./buyerupdate.js";
+export * from "./cancelstatus.js";
 export * from "./capturestatus.js";
 export * from "./cardpaymentmethodcreate.js";
 export * from "./cardscheme.js";
@@ -220,6 +221,7 @@ export * from "./threedsecurev2.js";
 export * from "./tokenpaymentmethodcreate.js";
 export * from "./transaction.js";
 export * from "./transactionbuyer.js";
+export * from "./transactioncancel.js";
 export * from "./transactioncapture.js";
 export * from "./transactioncapturecreate.js";
 export * from "./transactionconnectionoptions.js";

package/src/models/components/settlement.ts

@@ -13,43 +13,39 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type Settlement = {
   /**
-   * Always 'settlement'.
-   */
-  type?: "settlement" | undefined;
-  /**
-   * The unique identifier for the settlement.
+   * The unique identifier for the record.
    */
   id: string;
   /**
-   * The merchant account this settlement belongs to.
+   * The merchant account this record belongs to.
    */
   merchantAccountId: string;
   /**
-   * The date and time the settlement was created, in ISO 8601 format.
+   * The date and time the record was created, in ISO 8601 format.
    */
   createdAt: Date;
   /**
-   * The date and time the settlement was last updated, in ISO 8601 format.
+   * The date and time the record was last updated, in ISO 8601 format.
    */
   updatedAt: Date;
   /**
-   * The date and time the settlement was posted, in ISO 8601 format.
+   * The date and time the record was posted, in ISO 8601 format.
    */
   postedAt: Date;
   /**
-   * The date and time the settlement was ingested, in ISO 8601 format.
+   * The date and time the record was ingested, in ISO 8601 format.
    */
   ingestedAt: Date;
   /**
-   * ISO 4217 currency code for the settlement.
+   * ISO 4217 currency code.
    */
   currency: string;
   /**
-   * The total settled amount in the smallest currency unit (e.g. cents).
+   * The total amount in the smallest currency unit (e.g. cents).
    */
   amount: number;
   /**
-   * The exchange rate used for settlement, if applicable.
+   * The exchange rate, if applicable.
    */
   exchangeRate?: number | null | undefined;
   /**
@@ -77,9 +73,13 @@ export type Settlement = {
    */
   paymentServiceReportFileIds: Array<string>;
   /**
-   * The transaction this settlement is associated with.
+   * The transaction this record is associated with.
    */
   transactionId: string;
+  /**
+   * Always `settlement`.
+   */
+  type?: "settlement" | undefined;
 };
 
 /** @internal */
@@ -88,7 +88,6 @@ export const Settlement$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: z.literal("settlement").default("settlement"),
   id: z.string(),
   merchant_account_id: z.string(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -107,6 +106,7 @@ export const Settlement$inboundSchema: z.ZodType<
   payment_service_report_id: z.string(),
   payment_service_report_file_ids: z.array(z.string()),
   transaction_id: z.string(),
+  type: z.literal("settlement").default("settlement"),
 }).transform((v) => {
   return remap$(v, {
     "merchant_account_id": "merchantAccountId",
@@ -124,7 +124,6 @@ export const Settlement$inboundSchema: z.ZodType<
 
 /** @internal */
 export type Settlement$Outbound = {
-  type: "settlement";
   id: string;
   merchant_account_id: string;
   created_at: string;
@@ -141,6 +140,7 @@ export type Settlement$Outbound = {
   payment_service_report_id: string;
   payment_service_report_file_ids: Array<string>;
   transaction_id: string;
+  type: "settlement";
 };
 
 /** @internal */
@@ -149,7 +149,6 @@ export const Settlement$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Settlement
 > = z.object({
-  type: z.literal("settlement").default("settlement" as const),
   id: z.string(),
   merchantAccountId: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
@@ -166,6 +165,7 @@ export const Settlement$outboundSchema: z.ZodType<
   paymentServiceReportId: z.string(),
   paymentServiceReportFileIds: z.array(z.string()),
   transactionId: z.string(),
+  type: z.literal("settlement").default("settlement" as const),
 }).transform((v) => {
   return remap$(v, {
     merchantAccountId: "merchant_account_id",

package/src/models/components/transactioncancel.ts

@@ -0,0 +1,123 @@
+/*
+ * 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";
+import {
+  CancelStatus,
+  CancelStatus$inboundSchema,
+  CancelStatus$outboundSchema,
+} from "./cancelstatus.js";
+import {
+  Transaction,
+  Transaction$inboundSchema,
+  Transaction$Outbound,
+  Transaction$outboundSchema,
+} from "./transaction.js";
+
+export type TransactionCancel = {
+  /**
+   * Always `transaction-cancel`.
+   */
+  type?: "transaction-cancel" | undefined;
+  status: CancelStatus;
+  /**
+   * 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.
+   */
+  rawResponseDescription: string | null;
+  /**
+   * A full transaction resource.
+   */
+  transaction: Transaction;
+};
+
+/** @internal */
+export const TransactionCancel$inboundSchema: z.ZodType<
+  TransactionCancel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("transaction-cancel").default("transaction-cancel"),
+  status: CancelStatus$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 TransactionCancel$Outbound = {
+  type: "transaction-cancel";
+  status: string;
+  code: string | null;
+  raw_response_code: string | null;
+  raw_response_description: string | null;
+  transaction: Transaction$Outbound;
+};
+
+/** @internal */
+export const TransactionCancel$outboundSchema: z.ZodType<
+  TransactionCancel$Outbound,
+  z.ZodTypeDef,
+  TransactionCancel
+> = z.object({
+  type: z.literal("transaction-cancel").default("transaction-cancel" as const),
+  status: CancelStatus$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",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TransactionCancel$ {
+  /** @deprecated use `TransactionCancel$inboundSchema` instead. */
+  export const inboundSchema = TransactionCancel$inboundSchema;
+  /** @deprecated use `TransactionCancel$outboundSchema` instead. */
+  export const outboundSchema = TransactionCancel$outboundSchema;
+  /** @deprecated use `TransactionCancel$Outbound` instead. */
+  export type Outbound = TransactionCancel$Outbound;
+}
+
+export function transactionCancelToJSON(
+  transactionCancel: TransactionCancel,
+): string {
+  return JSON.stringify(
+    TransactionCancel$outboundSchema.parse(transactionCancel),
+  );
+}
+
+export function transactionCancelFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionCancel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionCancel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionCancel' from JSON`,
+  );
+}

package/src/models/components/transactionevent.ts

@@ -57,6 +57,8 @@ export const Name = {
     "payment-connector-response-transaction-capture-declined",
   PaymentConnectorResponseTransactionCancelSucceeded:
     "payment-connector-response-transaction-cancel-succeeded",
+  PaymentConnectorResponseTransactionCancelPending:
+    "payment-connector-response-transaction-cancel-pending",
   PaymentConnectorResponseTransactionCancelFailed:
     "payment-connector-response-transaction-cancel-failed",
   PaymentConnectorResponseTransactionVoidSucceeded: