@gr4vy/sdk 0.18.15 → 0.18.17

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`,
+  );
+}

package/src/models/components/paymentservicecreate.ts

@@ -0,0 +1,214 @@
+/*
+ * 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 {
+  MerchantProfileScheme,
+  MerchantProfileScheme$inboundSchema,
+  MerchantProfileScheme$Outbound,
+  MerchantProfileScheme$outboundSchema,
+} from "./merchantprofilescheme.js";
+
+/**
+ * Request body for activating a payment service
+ */
+export type PaymentServiceCreate = {
+  /**
+   * The display name for the payment service.
+   */
+  displayName: string;
+  /**
+   * The definition ID of the service to configure.
+   */
+  paymentServiceDefinitionId: string;
+  /**
+   * The non-secret credential fields that have been configured for this payment service. Any secret fields are omitted.
+   */
+  fields: Array<Field>;
+  /**
+   * The non-secret reporting fields that have been configured for this payment service. Any secret fields are omitted.
+   */
+  reportingFields?: Array<Field> | null | undefined;
+  /**
+   * Deprecated field used to define the order in which to process payment services
+   */
+  position?: number | null | 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 is currently active.
+   */
+  active?: boolean | null | undefined;
+  /**
+   * Defines if this payment service has 3DS enabled.
+   */
+  threeDSecureEnabled?: boolean | 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]: MerchantProfileScheme | null }
+    | null
+    | undefined;
+  /**
+   * Defines if this payment service support payment method tokenization.
+   */
+  paymentMethodTokenizationEnabled?: boolean | null | undefined;
+  /**
+   * Defines if this payment service supports network tokens.
+   */
+  networkTokensEnabled?: boolean | null | undefined;
+  /**
+   * Defines if this payment service is open loop.
+   */
+  openLoop?: boolean | null | undefined;
+  /**
+   * Defines if this payment service has settlement reporting enabled.
+   */
+  settlementReportingEnabled?: boolean | undefined;
+};
+
+/** @internal */
+export const PaymentServiceCreate$inboundSchema: z.ZodType<
+  PaymentServiceCreate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  display_name: z.string(),
+  payment_service_definition_id: z.string(),
+  fields: z.array(Field$inboundSchema),
+  reporting_fields: z.nullable(z.array(Field$inboundSchema)).optional(),
+  position: z.nullable(z.number().int()).optional(),
+  accepted_currencies: z.array(z.string()),
+  accepted_countries: z.array(z.string()),
+  active: z.nullable(z.boolean()).optional(),
+  three_d_secure_enabled: z.boolean().default(false),
+  merchant_profile: z.nullable(
+    z.record(z.nullable(MerchantProfileScheme$inboundSchema)),
+  ).optional(),
+  payment_method_tokenization_enabled: z.nullable(z.boolean()).optional(),
+  network_tokens_enabled: z.nullable(z.boolean()).optional(),
+  open_loop: z.nullable(z.boolean()).optional(),
+  settlement_reporting_enabled: z.boolean().default(false),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "payment_service_definition_id": "paymentServiceDefinitionId",
+    "reporting_fields": "reportingFields",
+    "accepted_currencies": "acceptedCurrencies",
+    "accepted_countries": "acceptedCountries",
+    "three_d_secure_enabled": "threeDSecureEnabled",
+    "merchant_profile": "merchantProfile",
+    "payment_method_tokenization_enabled": "paymentMethodTokenizationEnabled",
+    "network_tokens_enabled": "networkTokensEnabled",
+    "open_loop": "openLoop",
+    "settlement_reporting_enabled": "settlementReportingEnabled",
+  });
+});
+
+/** @internal */
+export type PaymentServiceCreate$Outbound = {
+  display_name: string;
+  payment_service_definition_id: string;
+  fields: Array<Field$Outbound>;
+  reporting_fields?: Array<Field$Outbound> | null | undefined;
+  position?: number | null | undefined;
+  accepted_currencies: Array<string>;
+  accepted_countries: Array<string>;
+  active?: boolean | null | undefined;
+  three_d_secure_enabled: boolean;
+  merchant_profile?:
+    | { [k: string]: MerchantProfileScheme$Outbound | null }
+    | null
+    | undefined;
+  payment_method_tokenization_enabled?: boolean | null | undefined;
+  network_tokens_enabled?: boolean | null | undefined;
+  open_loop?: boolean | null | undefined;
+  settlement_reporting_enabled: boolean;
+};
+
+/** @internal */
+export const PaymentServiceCreate$outboundSchema: z.ZodType<
+  PaymentServiceCreate$Outbound,
+  z.ZodTypeDef,
+  PaymentServiceCreate
+> = z.object({
+  displayName: z.string(),
+  paymentServiceDefinitionId: z.string(),
+  fields: z.array(Field$outboundSchema),
+  reportingFields: z.nullable(z.array(Field$outboundSchema)).optional(),
+  position: z.nullable(z.number().int()).optional(),
+  acceptedCurrencies: z.array(z.string()),
+  acceptedCountries: z.array(z.string()),
+  active: z.nullable(z.boolean()).optional(),
+  threeDSecureEnabled: z.boolean().default(false),
+  merchantProfile: z.nullable(
+    z.record(z.nullable(MerchantProfileScheme$outboundSchema)),
+  ).optional(),
+  paymentMethodTokenizationEnabled: z.nullable(z.boolean()).optional(),
+  networkTokensEnabled: z.nullable(z.boolean()).optional(),
+  openLoop: z.nullable(z.boolean()).optional(),
+  settlementReportingEnabled: z.boolean().default(false),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    paymentServiceDefinitionId: "payment_service_definition_id",
+    reportingFields: "reporting_fields",
+    acceptedCurrencies: "accepted_currencies",
+    acceptedCountries: "accepted_countries",
+    threeDSecureEnabled: "three_d_secure_enabled",
+    merchantProfile: "merchant_profile",
+    paymentMethodTokenizationEnabled: "payment_method_tokenization_enabled",
+    networkTokensEnabled: "network_tokens_enabled",
+    openLoop: "open_loop",
+    settlementReportingEnabled: "settlement_reporting_enabled",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaymentServiceCreate$ {
+  /** @deprecated use `PaymentServiceCreate$inboundSchema` instead. */
+  export const inboundSchema = PaymentServiceCreate$inboundSchema;
+  /** @deprecated use `PaymentServiceCreate$outboundSchema` instead. */
+  export const outboundSchema = PaymentServiceCreate$outboundSchema;
+  /** @deprecated use `PaymentServiceCreate$Outbound` instead. */
+  export type Outbound = PaymentServiceCreate$Outbound;
+}
+
+export function paymentServiceCreateToJSON(
+  paymentServiceCreate: PaymentServiceCreate,
+): string {
+  return JSON.stringify(
+    PaymentServiceCreate$outboundSchema.parse(paymentServiceCreate),
+  );
+}
+
+export function paymentServiceCreateFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentServiceCreate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentServiceCreate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentServiceCreate' from JSON`,
+  );
+}

package/src/models/components/paymentservicedefinition.ts

@@ -0,0 +1,193 @@
+/*
+ * 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 {
+  DefinitionField,
+  DefinitionField$inboundSchema,
+  DefinitionField$Outbound,
+  DefinitionField$outboundSchema,
+} from "./definitionfield.js";
+import {
+  Method,
+  Method$inboundSchema,
+  Method$outboundSchema,
+} from "./method.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+import {
+  PaymentServiceConfiguration,
+  PaymentServiceConfiguration$inboundSchema,
+  PaymentServiceConfiguration$Outbound,
+  PaymentServiceConfiguration$outboundSchema,
+} from "./paymentserviceconfiguration.js";
+import {
+  RequiredCheckoutFields,
+  RequiredCheckoutFields$inboundSchema,
+  RequiredCheckoutFields$Outbound,
+  RequiredCheckoutFields$outboundSchema,
+} from "./requiredcheckoutfields.js";
+
+export type PaymentServiceDefinition = {
+  /**
+   * The definition ID of the payment service that can be configured. This is the underlying provider followed by a dash followed by the method.
+   */
+  id: string;
+  /**
+   * Always `payment-service-definition`.
+   */
+  type?: "payment-service-definition" | undefined;
+  /**
+   * A human friendly name for this service.
+   */
+  displayName: string;
+  method: Method;
+  /**
+   * A list of credentials and related fields which can be configured for this service.
+   */
+  fields: Array<DefinitionField>;
+  /**
+   * A list of reporting fields which can be configured for this service.
+   */
+  reportingFields: Array<DefinitionField>;
+  /**
+   * A list of three-letter ISO currency codes that this service supports.
+   */
+  supportedCurrencies: Array<string>;
+  /**
+   * A list of two-letter ISO country codes that this service supports.
+   */
+  supportedCountries: Array<string>;
+  mode: Mode;
+  /**
+   * An icon to display for the payment service.
+   */
+  iconUrl?: string | null | undefined;
+  /**
+   * Features supported by the payment service.
+   */
+  supportedFeatures: { [k: string]: boolean };
+  /**
+   * A list of condition that define when some fields must be provided with a transaction request.
+   */
+  requiredCheckoutFields: Array<RequiredCheckoutFields>;
+  configuration: PaymentServiceConfiguration;
+};
+
+/** @internal */
+export const PaymentServiceDefinition$inboundSchema: z.ZodType<
+  PaymentServiceDefinition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  type: z.literal("payment-service-definition").default(
+    "payment-service-definition",
+  ),
+  display_name: z.string(),
+  method: Method$inboundSchema,
+  fields: z.array(DefinitionField$inboundSchema),
+  reporting_fields: z.array(DefinitionField$inboundSchema),
+  supported_currencies: z.array(z.string()),
+  supported_countries: z.array(z.string()),
+  mode: Mode$inboundSchema,
+  icon_url: z.nullable(z.string()).optional(),
+  supported_features: z.record(z.boolean()),
+  required_checkout_fields: z.array(RequiredCheckoutFields$inboundSchema),
+  configuration: PaymentServiceConfiguration$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "reporting_fields": "reportingFields",
+    "supported_currencies": "supportedCurrencies",
+    "supported_countries": "supportedCountries",
+    "icon_url": "iconUrl",
+    "supported_features": "supportedFeatures",
+    "required_checkout_fields": "requiredCheckoutFields",
+  });
+});
+
+/** @internal */
+export type PaymentServiceDefinition$Outbound = {
+  id: string;
+  type: "payment-service-definition";
+  display_name: string;
+  method: string;
+  fields: Array<DefinitionField$Outbound>;
+  reporting_fields: Array<DefinitionField$Outbound>;
+  supported_currencies: Array<string>;
+  supported_countries: Array<string>;
+  mode: string;
+  icon_url?: string | null | undefined;
+  supported_features: { [k: string]: boolean };
+  required_checkout_fields: Array<RequiredCheckoutFields$Outbound>;
+  configuration: PaymentServiceConfiguration$Outbound;
+};
+
+/** @internal */
+export const PaymentServiceDefinition$outboundSchema: z.ZodType<
+  PaymentServiceDefinition$Outbound,
+  z.ZodTypeDef,
+  PaymentServiceDefinition
+> = z.object({
+  id: z.string(),
+  type: z.literal("payment-service-definition").default(
+    "payment-service-definition" as const,
+  ),
+  displayName: z.string(),
+  method: Method$outboundSchema,
+  fields: z.array(DefinitionField$outboundSchema),
+  reportingFields: z.array(DefinitionField$outboundSchema),
+  supportedCurrencies: z.array(z.string()),
+  supportedCountries: z.array(z.string()),
+  mode: Mode$outboundSchema,
+  iconUrl: z.nullable(z.string()).optional(),
+  supportedFeatures: z.record(z.boolean()),
+  requiredCheckoutFields: z.array(RequiredCheckoutFields$outboundSchema),
+  configuration: PaymentServiceConfiguration$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    reportingFields: "reporting_fields",
+    supportedCurrencies: "supported_currencies",
+    supportedCountries: "supported_countries",
+    iconUrl: "icon_url",
+    supportedFeatures: "supported_features",
+    requiredCheckoutFields: "required_checkout_fields",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaymentServiceDefinition$ {
+  /** @deprecated use `PaymentServiceDefinition$inboundSchema` instead. */
+  export const inboundSchema = PaymentServiceDefinition$inboundSchema;
+  /** @deprecated use `PaymentServiceDefinition$outboundSchema` instead. */
+  export const outboundSchema = PaymentServiceDefinition$outboundSchema;
+  /** @deprecated use `PaymentServiceDefinition$Outbound` instead. */
+  export type Outbound = PaymentServiceDefinition$Outbound;
+}
+
+export function paymentServiceDefinitionToJSON(
+  paymentServiceDefinition: PaymentServiceDefinition,
+): string {
+  return JSON.stringify(
+    PaymentServiceDefinition$outboundSchema.parse(paymentServiceDefinition),
+  );
+}
+
+export function paymentServiceDefinitionFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentServiceDefinition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentServiceDefinition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentServiceDefinition' from JSON`,
+  );
+}

package/src/models/components/paymentservicestatus.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 PaymentServiceStatus = {
+  Pending: "pending",
+  Created: "created",
+  Failed: "failed",
+} as const;
+export type PaymentServiceStatus = OpenEnum<typeof PaymentServiceStatus>;
+
+/** @internal */
+export const PaymentServiceStatus$inboundSchema: z.ZodType<
+  PaymentServiceStatus,
+  z.ZodTypeDef,
+  unknown
+> = z
+  .union([
+    z.nativeEnum(PaymentServiceStatus),
+    z.string().transform(catchUnrecognizedEnum),
+  ]);
+
+/** @internal */
+export const PaymentServiceStatus$outboundSchema: z.ZodType<
+  PaymentServiceStatus,
+  z.ZodTypeDef,
+  PaymentServiceStatus
+> = z.union([
+  z.nativeEnum(PaymentServiceStatus),
+  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 PaymentServiceStatus$ {
+  /** @deprecated use `PaymentServiceStatus$inboundSchema` instead. */
+  export const inboundSchema = PaymentServiceStatus$inboundSchema;
+  /** @deprecated use `PaymentServiceStatus$outboundSchema` instead. */
+  export const outboundSchema = PaymentServiceStatus$outboundSchema;
+}