@gr4vy/sdk 0.18.16 → 0.18.18

package/src/models/components/merchantprofileschemesummary.ts

@@ -0,0 +1,131 @@
+/*
+ * 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";
+
+export type MerchantProfileSchemeSummary = {
+  /**
+   * Acquirer BIN to use when calling 3DS through this scheme.
+   */
+  merchantAcquirerBin: string;
+  /**
+   * URL to send when calling 3DS through this scheme.
+   */
+  merchantUrl: string;
+  /**
+   * Merchant ID to use when calling 3DS through this scheme.
+   */
+  merchantAcquirerId: string;
+  merchantName: string;
+  /**
+   * Merchant country code to use when calling 3DS through this scheme.
+   */
+  merchantCountryCode: string;
+  /**
+   * Merchant category code to use when calling 3DS through this scheme.
+   */
+  merchantCategoryCode: string;
+  /**
+   * The date and time when this profile was first created in our system.
+   */
+  createdAt: Date;
+};
+
+/** @internal */
+export const MerchantProfileSchemeSummary$inboundSchema: z.ZodType<
+  MerchantProfileSchemeSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  merchant_acquirer_bin: z.string(),
+  merchant_url: z.string(),
+  merchant_acquirer_id: z.string(),
+  merchant_name: z.string(),
+  merchant_country_code: z.string(),
+  merchant_category_code: z.string(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "merchant_acquirer_bin": "merchantAcquirerBin",
+    "merchant_url": "merchantUrl",
+    "merchant_acquirer_id": "merchantAcquirerId",
+    "merchant_name": "merchantName",
+    "merchant_country_code": "merchantCountryCode",
+    "merchant_category_code": "merchantCategoryCode",
+    "created_at": "createdAt",
+  });
+});
+
+/** @internal */
+export type MerchantProfileSchemeSummary$Outbound = {
+  merchant_acquirer_bin: string;
+  merchant_url: string;
+  merchant_acquirer_id: string;
+  merchant_name: string;
+  merchant_country_code: string;
+  merchant_category_code: string;
+  created_at: string;
+};
+
+/** @internal */
+export const MerchantProfileSchemeSummary$outboundSchema: z.ZodType<
+  MerchantProfileSchemeSummary$Outbound,
+  z.ZodTypeDef,
+  MerchantProfileSchemeSummary
+> = z.object({
+  merchantAcquirerBin: z.string(),
+  merchantUrl: z.string(),
+  merchantAcquirerId: z.string(),
+  merchantName: z.string(),
+  merchantCountryCode: z.string(),
+  merchantCategoryCode: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    merchantAcquirerBin: "merchant_acquirer_bin",
+    merchantUrl: "merchant_url",
+    merchantAcquirerId: "merchant_acquirer_id",
+    merchantName: "merchant_name",
+    merchantCountryCode: "merchant_country_code",
+    merchantCategoryCode: "merchant_category_code",
+    createdAt: "created_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MerchantProfileSchemeSummary$ {
+  /** @deprecated use `MerchantProfileSchemeSummary$inboundSchema` instead. */
+  export const inboundSchema = MerchantProfileSchemeSummary$inboundSchema;
+  /** @deprecated use `MerchantProfileSchemeSummary$outboundSchema` instead. */
+  export const outboundSchema = MerchantProfileSchemeSummary$outboundSchema;
+  /** @deprecated use `MerchantProfileSchemeSummary$Outbound` instead. */
+  export type Outbound = MerchantProfileSchemeSummary$Outbound;
+}
+
+export function merchantProfileSchemeSummaryToJSON(
+  merchantProfileSchemeSummary: MerchantProfileSchemeSummary,
+): string {
+  return JSON.stringify(
+    MerchantProfileSchemeSummary$outboundSchema.parse(
+      merchantProfileSchemeSummary,
+    ),
+  );
+}
+
+export function merchantProfileSchemeSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantProfileSchemeSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantProfileSchemeSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantProfileSchemeSummary' from JSON`,
+  );
+}

package/src/models/components/paymentservice.ts

@@ -0,0 +1,281 @@
+/*
+ * 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 {
+  Field,
+  Field$inboundSchema,
+  Field$Outbound,
+  Field$outboundSchema,
+} from "./field.js";
+import {
+  MerchantProfileSchemeSummary,
+  MerchantProfileSchemeSummary$inboundSchema,
+  MerchantProfileSchemeSummary$Outbound,
+  MerchantProfileSchemeSummary$outboundSchema,
+} from "./merchantprofileschemesummary.js";
+import {
+  Method,
+  Method$inboundSchema,
+  Method$outboundSchema,
+} from "./method.js";
+import {
+  PaymentServiceStatus,
+  PaymentServiceStatus$inboundSchema,
+  PaymentServiceStatus$outboundSchema,
+} from "./paymentservicestatus.js";
+
+export type PaymentService = {
+  /**
+   * Always `payment-service`
+   */
+  type?: "payment-service" | undefined;
+  id?: string | undefined;
+  /**
+   * The ID of the merchant account this job belongs to.
+   */
+  merchantAccountId: string;
+  /**
+   * The definition ID of the service that has been configured.
+   */
+  paymentServiceDefinitionId: string;
+  /**
+   * Defines if this payment service is currently active.
+   */
+  active?: boolean | undefined;
+  method: Method;
+  /**
+   * The display name for the payment service.
+   */
+  displayName: string;
+  /**
+   * Deprecated field used to define the order in which to process payment services
+   */
+  position: number;
+  status?: PaymentServiceStatus | undefined;
+  /**
+   * A list of currencies for which this service is enabled, in ISO 4217 three-letter code format.
+   */
+  acceptedCurrencies: Array<string>;
+  /**
+   * A list of countries for which this service is enabled, in ISO two-letter code format.
+   */
+  acceptedCountries: Array<string>;
+  /**
+   * Defines if this payment service support payment method tokenization.
+   */
+  paymentMethodTokenizationEnabled: boolean;
+  /**
+   * Defines if this payment service supports network tokens.
+   */
+  networkTokensEnabled: boolean;
+  /**
+   * Defines if this payment service is open loop.
+   */
+  openLoop: boolean;
+  /**
+   * Defines if this payment service has settlement reporting enabled.
+   */
+  settlementReportingEnabled: boolean;
+  /**
+   * Defines if this payment service has 3DS enabled.
+   */
+  threeDSecureEnabled?: boolean | null | undefined;
+  /**
+   * An object containing a key for each supported card schemes, and for each key an object with the 3DS profile for this service for that scheme.
+   */
+  merchantProfile?:
+    | { [k: string]: MerchantProfileSchemeSummary | null }
+    | null
+    | undefined;
+  /**
+   * The URL that needs to be configured with this payment service as the receiving endpoint for webhooks from the service to our system. Currently, we dp not yet automatically register webhooks on setup, and therefore webhooks need to be registered manually by the merchant.
+   */
+  webhookUrl?: string | null | undefined;
+  /**
+   * The non-secret credential fields that have been configured for this payment service. Any secret fields are omitted.
+   */
+  fields?: Array<Field> | null | undefined;
+  /**
+   * The non-secret reporting fields that have been configured for this payment service. Any secret fields are omitted.
+   */
+  reportingFields?: Array<Field> | null | undefined;
+  /**
+   * Defines if this payment service has been deleted
+   */
+  isDeleted?: boolean | undefined;
+  /**
+   * The date and time when this payment service was first created in our system.
+   */
+  createdAt: Date;
+  /**
+   * The date and time when this payment service was last updated in our system.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const PaymentService$inboundSchema: z.ZodType<
+  PaymentService,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("payment-service").default("payment-service"),
+  id: z.string().default("The ID of the payment service"),
+  merchant_account_id: z.string(),
+  payment_service_definition_id: z.string(),
+  active: z.boolean().default(true),
+  method: Method$inboundSchema,
+  display_name: z.string(),
+  position: z.number().int(),
+  status: PaymentServiceStatus$inboundSchema.optional(),
+  accepted_currencies: z.array(z.string()),
+  accepted_countries: z.array(z.string()),
+  payment_method_tokenization_enabled: z.boolean(),
+  network_tokens_enabled: z.boolean(),
+  open_loop: z.boolean(),
+  settlement_reporting_enabled: z.boolean(),
+  three_d_secure_enabled: z.nullable(z.boolean()).optional(),
+  merchant_profile: z.nullable(
+    z.record(z.nullable(MerchantProfileSchemeSummary$inboundSchema)),
+  ).optional(),
+  webhook_url: z.nullable(z.string()).optional(),
+  fields: z.nullable(z.array(Field$inboundSchema)).optional(),
+  reporting_fields: z.nullable(z.array(Field$inboundSchema)).optional(),
+  is_deleted: z.boolean().default(false),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "merchant_account_id": "merchantAccountId",
+    "payment_service_definition_id": "paymentServiceDefinitionId",
+    "display_name": "displayName",
+    "accepted_currencies": "acceptedCurrencies",
+    "accepted_countries": "acceptedCountries",
+    "payment_method_tokenization_enabled": "paymentMethodTokenizationEnabled",
+    "network_tokens_enabled": "networkTokensEnabled",
+    "open_loop": "openLoop",
+    "settlement_reporting_enabled": "settlementReportingEnabled",
+    "three_d_secure_enabled": "threeDSecureEnabled",
+    "merchant_profile": "merchantProfile",
+    "webhook_url": "webhookUrl",
+    "reporting_fields": "reportingFields",
+    "is_deleted": "isDeleted",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+/** @internal */
+export type PaymentService$Outbound = {
+  type: "payment-service";
+  id: string;
+  merchant_account_id: string;
+  payment_service_definition_id: string;
+  active: boolean;
+  method: string;
+  display_name: string;
+  position: number;
+  status?: string | undefined;
+  accepted_currencies: Array<string>;
+  accepted_countries: Array<string>;
+  payment_method_tokenization_enabled: boolean;
+  network_tokens_enabled: boolean;
+  open_loop: boolean;
+  settlement_reporting_enabled: boolean;
+  three_d_secure_enabled?: boolean | null | undefined;
+  merchant_profile?:
+    | { [k: string]: MerchantProfileSchemeSummary$Outbound | null }
+    | null
+    | undefined;
+  webhook_url?: string | null | undefined;
+  fields?: Array<Field$Outbound> | null | undefined;
+  reporting_fields?: Array<Field$Outbound> | null | undefined;
+  is_deleted: boolean;
+  created_at: string;
+  updated_at: string;
+};
+
+/** @internal */
+export const PaymentService$outboundSchema: z.ZodType<
+  PaymentService$Outbound,
+  z.ZodTypeDef,
+  PaymentService
+> = z.object({
+  type: z.literal("payment-service").default("payment-service" as const),
+  id: z.string().default("The ID of the payment service"),
+  merchantAccountId: z.string(),
+  paymentServiceDefinitionId: z.string(),
+  active: z.boolean().default(true),
+  method: Method$outboundSchema,
+  displayName: z.string(),
+  position: z.number().int(),
+  status: PaymentServiceStatus$outboundSchema.optional(),
+  acceptedCurrencies: z.array(z.string()),
+  acceptedCountries: z.array(z.string()),
+  paymentMethodTokenizationEnabled: z.boolean(),
+  networkTokensEnabled: z.boolean(),
+  openLoop: z.boolean(),
+  settlementReportingEnabled: z.boolean(),
+  threeDSecureEnabled: z.nullable(z.boolean()).optional(),
+  merchantProfile: z.nullable(
+    z.record(z.nullable(MerchantProfileSchemeSummary$outboundSchema)),
+  ).optional(),
+  webhookUrl: z.nullable(z.string()).optional(),
+  fields: z.nullable(z.array(Field$outboundSchema)).optional(),
+  reportingFields: z.nullable(z.array(Field$outboundSchema)).optional(),
+  isDeleted: z.boolean().default(false),
+  createdAt: z.date().transform(v => v.toISOString()),
+  updatedAt: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    merchantAccountId: "merchant_account_id",
+    paymentServiceDefinitionId: "payment_service_definition_id",
+    displayName: "display_name",
+    acceptedCurrencies: "accepted_currencies",
+    acceptedCountries: "accepted_countries",
+    paymentMethodTokenizationEnabled: "payment_method_tokenization_enabled",
+    networkTokensEnabled: "network_tokens_enabled",
+    openLoop: "open_loop",
+    settlementReportingEnabled: "settlement_reporting_enabled",
+    threeDSecureEnabled: "three_d_secure_enabled",
+    merchantProfile: "merchant_profile",
+    webhookUrl: "webhook_url",
+    reportingFields: "reporting_fields",
+    isDeleted: "is_deleted",
+    createdAt: "created_at",
+    updatedAt: "updated_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaymentService$ {
+  /** @deprecated use `PaymentService$inboundSchema` instead. */
+  export const inboundSchema = PaymentService$inboundSchema;
+  /** @deprecated use `PaymentService$outboundSchema` instead. */
+  export const outboundSchema = PaymentService$outboundSchema;
+  /** @deprecated use `PaymentService$Outbound` instead. */
+  export type Outbound = PaymentService$Outbound;
+}
+
+export function paymentServiceToJSON(paymentService: PaymentService): string {
+  return JSON.stringify(PaymentService$outboundSchema.parse(paymentService));
+}
+
+export function paymentServiceFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentService, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentService$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentService' from JSON`,
+  );
+}

package/src/models/components/paymentserviceconfiguration.ts

@@ -0,0 +1,127 @@
+/*
+ * 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 {
+  ApprovalTarget,
+  ApprovalTarget$inboundSchema,
+  ApprovalTarget$outboundSchema,
+} from "./approvaltarget.js";
+
+export type PaymentServiceConfiguration = {
+  approvalUiTarget: ApprovalTarget;
+  /**
+   * Height of the approval interface in either pixels or view height (vh).
+   */
+  approvalUiHeight: string;
+  /**
+   * Width of the approval interface in either pixels or view width (vw).
+   */
+  approvalUiWidth: string;
+  /**
+   * The maximum number of cart items supported by this connector before we will truncate the list.
+   */
+  cartItemsLimit: number;
+  /**
+   * Defines if cart items are required by this connector.
+   */
+  cartItemsRequired: boolean;
+  /**
+   * Defines if the cart items sum value should match the transaction amount.
+   */
+  cartItemsShouldMatchAmount: boolean;
+};
+
+/** @internal */
+export const PaymentServiceConfiguration$inboundSchema: z.ZodType<
+  PaymentServiceConfiguration,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  approval_ui_target: ApprovalTarget$inboundSchema,
+  approval_ui_height: z.string(),
+  approval_ui_width: z.string(),
+  cart_items_limit: z.number().int(),
+  cart_items_required: z.boolean(),
+  cart_items_should_match_amount: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "approval_ui_target": "approvalUiTarget",
+    "approval_ui_height": "approvalUiHeight",
+    "approval_ui_width": "approvalUiWidth",
+    "cart_items_limit": "cartItemsLimit",
+    "cart_items_required": "cartItemsRequired",
+    "cart_items_should_match_amount": "cartItemsShouldMatchAmount",
+  });
+});
+
+/** @internal */
+export type PaymentServiceConfiguration$Outbound = {
+  approval_ui_target: string;
+  approval_ui_height: string;
+  approval_ui_width: string;
+  cart_items_limit: number;
+  cart_items_required: boolean;
+  cart_items_should_match_amount: boolean;
+};
+
+/** @internal */
+export const PaymentServiceConfiguration$outboundSchema: z.ZodType<
+  PaymentServiceConfiguration$Outbound,
+  z.ZodTypeDef,
+  PaymentServiceConfiguration
+> = z.object({
+  approvalUiTarget: ApprovalTarget$outboundSchema,
+  approvalUiHeight: z.string(),
+  approvalUiWidth: z.string(),
+  cartItemsLimit: z.number().int(),
+  cartItemsRequired: z.boolean(),
+  cartItemsShouldMatchAmount: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    approvalUiTarget: "approval_ui_target",
+    approvalUiHeight: "approval_ui_height",
+    approvalUiWidth: "approval_ui_width",
+    cartItemsLimit: "cart_items_limit",
+    cartItemsRequired: "cart_items_required",
+    cartItemsShouldMatchAmount: "cart_items_should_match_amount",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaymentServiceConfiguration$ {
+  /** @deprecated use `PaymentServiceConfiguration$inboundSchema` instead. */
+  export const inboundSchema = PaymentServiceConfiguration$inboundSchema;
+  /** @deprecated use `PaymentServiceConfiguration$outboundSchema` instead. */
+  export const outboundSchema = PaymentServiceConfiguration$outboundSchema;
+  /** @deprecated use `PaymentServiceConfiguration$Outbound` instead. */
+  export type Outbound = PaymentServiceConfiguration$Outbound;
+}
+
+export function paymentServiceConfigurationToJSON(
+  paymentServiceConfiguration: PaymentServiceConfiguration,
+): string {
+  return JSON.stringify(
+    PaymentServiceConfiguration$outboundSchema.parse(
+      paymentServiceConfiguration,
+    ),
+  );
+}
+
+export function paymentServiceConfigurationFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentServiceConfiguration, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentServiceConfiguration$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentServiceConfiguration' from JSON`,
+  );
+}