@gr4vy/sdk 1.9.5 → 1.9.7

package/src/funcs/transactionsActionsList.ts

@@ -0,0 +1,259 @@
+/*
+ * 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";
+
+/**
+ * Get Flow actions for transaction
+ *
+ * @remarks
+ * Retrieve the list of Flow actions that have been triggered for a transaction.
+ */
+export function transactionsActionsList(
+  client: Gr4vyCore,
+  transactionId: string,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TransactionActions,
+    | 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.TransactionActions,
+      | 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.ListTransactionActionsRequest = {
+    transactionId: transactionId,
+    merchantAccountId: merchantAccountId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.ListTransactionActionsRequest$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}/actions")(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_actions",
+    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,
+    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.TransactionActions,
+    | 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.TransactionActions$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.9.5",
-  genVersion: "2.788.4",
-  userAgent: "speakeasy-sdk/typescript 1.9.5 2.788.4 1.0.0 @gr4vy/sdk",
+  sdkVersion: "1.9.7",
+  genVersion: "2.791.1",
+  userAgent: "speakeasy-sdk/typescript 1.9.7 2.791.1 1.0.0 @gr4vy/sdk",
 } as const;

package/src/models/components/flow.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const Flow = {
+  Checkout: "checkout",
+  CardTransaction: "card-transaction",
+  NonCardTransaction: "non-card-transaction",
+  RedirectTransaction: "redirect-transaction",
+} as const;
+export type Flow = OpenEnum<typeof Flow>;
+
+/** @internal */
+export const Flow$inboundSchema: z.ZodType<Flow, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Flow);

package/src/models/components/flowaction.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const FlowAction = {
+  SelectPaymentOptions: "select-payment-options",
+  RouteTransaction: "route-transaction",
+  DeclineEarly: "decline-early",
+  Skip3ds: "skip-3ds",
+} as const;
+export type FlowAction = OpenEnum<typeof FlowAction>;
+
+/** @internal */
+export const FlowAction$inboundSchema: z.ZodType<
+  FlowAction,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FlowAction);

package/src/models/components/index.ts

@@ -85,6 +85,8 @@ export * from "./errorlocation.js";
 export * from "./field.js";
 export * from "./fiservinstallmentoptions.js";
 export * from "./fiservoptions.js";
+export * from "./flow.js";
+export * from "./flowaction.js";
 export * from "./forterantifraudoptions.js";
 export * from "./forterantifraudoptionscartitem.js";
 export * from "./forterantifraudoptionscartitembasicitemdata.js";
@@ -231,6 +233,8 @@ export * from "./threedsecurestatus.js";
 export * from "./threedsecurev2.js";
 export * from "./tokenpaymentmethodcreate.js";
 export * from "./transaction.js";
+export * from "./transactionaction.js";
+export * from "./transactionactions.js";
 export * from "./transactionbuyer.js";
 export * from "./transactioncancel.js";
 export * from "./transactioncapture.js";

package/src/models/components/transactionaction.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 { Flow, Flow$inboundSchema } from "./flow.js";
+import { FlowAction, FlowAction$inboundSchema } from "./flowaction.js";
+
+export type TransactionAction = {
+  /**
+   * Always `action`.
+   */
+  type: "action";
+  id: FlowAction;
+  flow: Flow;
+  /**
+   * The ID of the rule that triggered this action.
+   */
+  ruleId: string;
+  /**
+   * The date this action was created at.
+   */
+  createdAt: Date;
+  /**
+   * The outcome of the action.
+   */
+  outcome: { [k: string]: any };
+};
+
+/** @internal */
+export const TransactionAction$inboundSchema: z.ZodType<
+  TransactionAction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("action").default("action"),
+  id: FlowAction$inboundSchema,
+  flow: Flow$inboundSchema,
+  rule_id: z.string(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  outcome: z.record(z.any()),
+}).transform((v) => {
+  return remap$(v, {
+    "rule_id": "ruleId",
+    "created_at": "createdAt",
+  });
+});
+
+export function transactionActionFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionAction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionAction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionAction' from JSON`,
+  );
+}

package/src/models/components/transactionactions.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 {
+  TransactionAction,
+  TransactionAction$inboundSchema,
+} from "./transactionaction.js";
+
+export type TransactionActions = {
+  /**
+   * The list of actions triggered for a transaction.
+   */
+  items: Array<TransactionAction>;
+};
+
+/** @internal */
+export const TransactionActions$inboundSchema: z.ZodType<
+  TransactionActions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(TransactionAction$inboundSchema),
+});
+
+export function transactionActionsFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionActions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionActions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionActions' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -74,6 +74,7 @@ export * from "./listpaymentservices.js";
 export * from "./listpayouts.js";
 export * from "./listreportexecutions.js";
 export * from "./listreports.js";
+export * from "./listtransactionactions.js";
 export * from "./listtransactionevents.js";
 export * from "./listtransactionrefunds.js";
 export * from "./listtransactions.js";

package/src/models/operations/listtransactionactions.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 ListTransactionActionsGlobals = {
+  merchantAccountId?: string | undefined;
+};
+
+export type ListTransactionActionsRequest = {
+  /**
+   * The ID of the transaction
+   */
+  transactionId: string;
+  /**
+   * The ID of the merchant account to use for this request.
+   */
+  merchantAccountId?: string | null | undefined;
+};
+
+/** @internal */
+export type ListTransactionActionsRequest$Outbound = {
+  transaction_id: string;
+  merchantAccountId?: string | null | undefined;
+};
+
+/** @internal */
+export const ListTransactionActionsRequest$outboundSchema: z.ZodType<
+  ListTransactionActionsRequest$Outbound,
+  z.ZodTypeDef,
+  ListTransactionActionsRequest
+> = z.object({
+  transactionId: z.string(),
+  merchantAccountId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    transactionId: "transaction_id",
+  });
+});
+
+export function listTransactionActionsRequestToJSON(
+  listTransactionActionsRequest: ListTransactionActionsRequest,
+): string {
+  return JSON.stringify(
+    ListTransactionActionsRequest$outboundSchema.parse(
+      listTransactionActionsRequest,
+    ),
+  );
+}

package/src/sdk/actions.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionsActionsList } from "../funcs/transactionsActionsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Actions extends ClientSDK {
+  /**
+   * Get Flow actions for transaction
+   *
+   * @remarks
+   * Retrieve the list of Flow actions that have been triggered for a transaction.
+   */
+  async list(
+    transactionId: string,
+    merchantAccountId?: string | null | undefined,
+    options?: RequestOptions,
+  ): Promise<components.TransactionActions> {
+    return unwrapAsync(transactionsActionsList(
+      this,
+      transactionId,
+      merchantAccountId,
+      options,
+    ));
+  }
+}

package/src/sdk/transactions.ts

@@ -15,6 +15,7 @@ import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { Actions } from "./actions.js";
 import { Events } from "./events.js";
 import { Gr4vyRefunds } from "./gr4vyrefunds.js";
 import { Settlements } from "./settlements.js";
@@ -25,6 +26,11 @@ export class Transactions extends ClientSDK {
     return (this._refunds ??= new Gr4vyRefunds(this._options));
   }
 
+  private _actions?: Actions;
+  get actions(): Actions {
+    return (this._actions ??= new Actions(this._options));
+  }
+
   private _events?: Events;
   get events(): Events {
     return (this._events ??= new Events(this._options));