@moovio/sdk 0.0.0-dev.26 → 0.0.0-dev.27

package/src/models/operations/gettransferriskoutcomes.ts

@@ -0,0 +1,136 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetTransferRiskOutcomesRequest = {
+  /**
+   * Identifier for the transfer.
+   */
+  transferID: string;
+  /**
+   * The account the transfer belongs to. When omitted, the account is resolved
+   *
+   * @remarks
+   * from the calling credentials.
+   */
+  xAccountID?: string | undefined;
+};
+
+export type GetTransferRiskOutcomesResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.PartnerRiskOutcomesResponse;
+};
+
+/** @internal */
+export const GetTransferRiskOutcomesRequest$inboundSchema: z.ZodType<
+  GetTransferRiskOutcomesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transferID: types.string(),
+  "X-Account-ID": types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "X-Account-ID": "xAccountID",
+  });
+});
+/** @internal */
+export type GetTransferRiskOutcomesRequest$Outbound = {
+  transferID: string;
+  "X-Account-ID"?: string | undefined;
+};
+
+/** @internal */
+export const GetTransferRiskOutcomesRequest$outboundSchema: z.ZodType<
+  GetTransferRiskOutcomesRequest$Outbound,
+  z.ZodTypeDef,
+  GetTransferRiskOutcomesRequest
+> = z.object({
+  transferID: z.string(),
+  xAccountID: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    xAccountID: "X-Account-ID",
+  });
+});
+
+export function getTransferRiskOutcomesRequestToJSON(
+  getTransferRiskOutcomesRequest: GetTransferRiskOutcomesRequest,
+): string {
+  return JSON.stringify(
+    GetTransferRiskOutcomesRequest$outboundSchema.parse(
+      getTransferRiskOutcomesRequest,
+    ),
+  );
+}
+export function getTransferRiskOutcomesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTransferRiskOutcomesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetTransferRiskOutcomesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTransferRiskOutcomesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetTransferRiskOutcomesResponse$inboundSchema: z.ZodType<
+  GetTransferRiskOutcomesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.PartnerRiskOutcomesResponse$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type GetTransferRiskOutcomesResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.PartnerRiskOutcomesResponse$Outbound;
+};
+
+/** @internal */
+export const GetTransferRiskOutcomesResponse$outboundSchema: z.ZodType<
+  GetTransferRiskOutcomesResponse$Outbound,
+  z.ZodTypeDef,
+  GetTransferRiskOutcomesResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.PartnerRiskOutcomesResponse$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function getTransferRiskOutcomesResponseToJSON(
+  getTransferRiskOutcomesResponse: GetTransferRiskOutcomesResponse,
+): string {
+  return JSON.stringify(
+    GetTransferRiskOutcomesResponse$outboundSchema.parse(
+      getTransferRiskOutcomesResponse,
+    ),
+  );
+}
+export function getTransferRiskOutcomesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTransferRiskOutcomesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetTransferRiskOutcomesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTransferRiskOutcomesResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -96,6 +96,7 @@ export * from "./gettermsofservicetoken.js";
 export * from "./getticket.js";
 export * from "./gettransfer.js";
 export * from "./gettransferconfig.js";
+export * from "./gettransferriskoutcomes.js";
 export * from "./getunderwriting.js";
 export * from "./getwallet.js";
 export * from "./getwallettransaction.js";

package/src/sdk/transfers.ts

@@ -10,6 +10,7 @@ import { transfersGenerateOptions } from "../funcs/transfersGenerateOptions.js";
 import { transfersGet } from "../funcs/transfersGet.js";
 import { transfersGetCancellation } from "../funcs/transfersGetCancellation.js";
 import { transfersGetRefund } from "../funcs/transfersGetRefund.js";
+import { transfersGetRiskOutcomes } from "../funcs/transfersGetRiskOutcomes.js";
 import { transfersInitiateRefund } from "../funcs/transfersInitiateRefund.js";
 import { transfersList } from "../funcs/transfersList.js";
 import { transfersListCancellations } from "../funcs/transfersListCancellations.js";
@@ -268,4 +269,23 @@ export class Transfers extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Retrieve the risk rules that contributed to a transfer's risk decision.
+   *
+   * This endpoint has limited availability and must be enabled for your account by Moov.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
+   */
+  async getRiskOutcomes(
+    request: operations.GetTransferRiskOutcomesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetTransferRiskOutcomesResponse> {
+    return unwrapAsync(transfersGetRiskOutcomes(
+      this,
+      request,
+      options,
+    ));
+  }
 }