@gr4vy/sdk 2.0.51 → 2.0.53

package/src/models/components/pazeconsumer.ts

@@ -0,0 +1,65 @@
+/*
+ * 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 {
+  PazeMobileNumber,
+  PazeMobileNumber$inboundSchema,
+} from "./pazemobilenumber.js";
+
+export type PazeConsumer = {
+  /**
+   * First name of the consumer.
+   */
+  firstName: string | null;
+  /**
+   * Last name of the consumer.
+   */
+  lastName: string | null;
+  /**
+   * Full name of the consumer.
+   */
+  fullName: string;
+  /**
+   * ISO 3166-1 alpha-2 country code.
+   */
+  countryCode: string | null;
+  /**
+   * ISO 639-1 language code associated with the wallet.
+   */
+  languageCode: string | null;
+  /**
+   * Email address of the consumer.
+   */
+  emailAddress: string;
+  mobileNumber: PazeMobileNumber | null;
+};
+
+/** @internal */
+export const PazeConsumer$inboundSchema: z.ZodType<
+  PazeConsumer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  firstName: z.nullable(z.string()),
+  lastName: z.nullable(z.string()),
+  fullName: z.string(),
+  countryCode: z.nullable(z.string()),
+  languageCode: z.nullable(z.string()),
+  emailAddress: z.string(),
+  mobileNumber: z.nullable(PazeMobileNumber$inboundSchema),
+});
+
+export function pazeConsumerFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeConsumer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeConsumer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeConsumer' from JSON`,
+  );
+}

package/src/models/components/pazedeliverycontactdetails.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 {
+  PazeMobileNumber,
+  PazeMobileNumber$inboundSchema,
+} from "./pazemobilenumber.js";
+
+export type PazeDeliveryContactDetails = {
+  /**
+   * Consumer-provided name of the contact person.
+   */
+  contactFullName: string | null;
+  contactPhoneNumber: PazeMobileNumber | null;
+};
+
+/** @internal */
+export const PazeDeliveryContactDetails$inboundSchema: z.ZodType<
+  PazeDeliveryContactDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  contactFullName: z.nullable(z.string()),
+  contactPhoneNumber: z.nullable(PazeMobileNumber$inboundSchema),
+});
+
+export function pazeDeliveryContactDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeDeliveryContactDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeDeliveryContactDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeDeliveryContactDetails' from JSON`,
+  );
+}

package/src/models/components/pazedigitalcarddata.ts

@@ -0,0 +1,44 @@
+/*
+ * 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";
+
+export type PazeDigitalCardData = {
+  /**
+   * URI hosting the card art image.
+   */
+  artUri: string;
+  /**
+   * Card art height in pixels.
+   */
+  artHeight: number;
+  /**
+   * Card art width in pixels.
+   */
+  artWidth: number;
+};
+
+/** @internal */
+export const PazeDigitalCardData$inboundSchema: z.ZodType<
+  PazeDigitalCardData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  artUri: z.string(),
+  artHeight: z.number().int(),
+  artWidth: z.number().int(),
+});
+
+export function pazeDigitalCardDataFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeDigitalCardData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeDigitalCardData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeDigitalCardData' from JSON`,
+  );
+}

package/src/models/components/pazemaskedcard.ts

@@ -0,0 +1,142 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PazeBillingAddress,
+  PazeBillingAddress$inboundSchema,
+} from "./pazebillingaddress.js";
+import {
+  PazeDigitalCardData,
+  PazeDigitalCardData$inboundSchema,
+} from "./pazedigitalcarddata.js";
+
+/**
+ * Card type.
+ */
+export const Paymentcardtype = {
+  Credit: "CREDIT",
+  Debit: "DEBIT",
+} as const;
+/**
+ * Card type.
+ */
+export type Paymentcardtype = OpenEnum<typeof Paymentcardtype>;
+
+/**
+ * Card brand.
+ */
+export const Paymentcardbrand = {
+  Visa: "VISA",
+  Mastercard: "MASTERCARD",
+  Discover: "DISCOVER",
+} as const;
+/**
+ * Card brand.
+ */
+export type Paymentcardbrand = OpenEnum<typeof Paymentcardbrand>;
+
+/**
+ * Card network.
+ */
+export const Paymentcardnetwork = {
+  Visa: "VISA",
+  Mastercard: "MASTERCARD",
+  Discover: "DISCOVER",
+} as const;
+/**
+ * Card network.
+ */
+export type Paymentcardnetwork = OpenEnum<typeof Paymentcardnetwork>;
+
+export type PazeMaskedCard = {
+  /**
+   * Last four digits of the PAN.
+   */
+  panLastFour: string;
+  /**
+   * Payment Account Reference (PAR). A non-financial reference assigned to each unique PAN.
+   */
+  paymentAccountReference: string;
+  /**
+   * 2-digit PAN expiration month.
+   */
+  panExpirationMonth: string | null;
+  /**
+   * 4-digit PAN expiration year.
+   */
+  panExpirationYear: string | null;
+  /**
+   * Free-form string used for card or program recognition.
+   */
+  paymentCardDescriptor: string;
+  /**
+   * Card type.
+   */
+  paymentCardType: Paymentcardtype;
+  /**
+   * Card brand.
+   */
+  paymentCardBrand: Paymentcardbrand;
+  /**
+   * Card network.
+   */
+  paymentCardNetwork: Paymentcardnetwork;
+  digitalCardData: PazeDigitalCardData;
+  billingAddress: PazeBillingAddress | null;
+};
+
+/** @internal */
+export const Paymentcardtype$inboundSchema: z.ZodType<
+  Paymentcardtype,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Paymentcardtype);
+
+/** @internal */
+export const Paymentcardbrand$inboundSchema: z.ZodType<
+  Paymentcardbrand,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Paymentcardbrand);
+
+/** @internal */
+export const Paymentcardnetwork$inboundSchema: z.ZodType<
+  Paymentcardnetwork,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Paymentcardnetwork);
+
+/** @internal */
+export const PazeMaskedCard$inboundSchema: z.ZodType<
+  PazeMaskedCard,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  panLastFour: z.string(),
+  paymentAccountReference: z.string(),
+  panExpirationMonth: z.nullable(z.string()),
+  panExpirationYear: z.nullable(z.string()),
+  paymentCardDescriptor: z.string(),
+  paymentCardType: Paymentcardtype$inboundSchema,
+  paymentCardBrand: Paymentcardbrand$inboundSchema,
+  paymentCardNetwork: Paymentcardnetwork$inboundSchema,
+  digitalCardData: PazeDigitalCardData$inboundSchema,
+  billingAddress: z.nullable(PazeBillingAddress$inboundSchema),
+});
+
+export function pazeMaskedCardFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeMaskedCard, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeMaskedCard$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeMaskedCard' from JSON`,
+  );
+}

package/src/models/components/pazemobilenumber.ts

@@ -0,0 +1,39 @@
+/*
+ * 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";
+
+export type PazeMobileNumber = {
+  /**
+   * ITU country dialing code.
+   */
+  countryCode: string;
+  /**
+   * Phone number without country code.
+   */
+  phoneNumber: string;
+};
+
+/** @internal */
+export const PazeMobileNumber$inboundSchema: z.ZodType<
+  PazeMobileNumber,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  countryCode: z.string(),
+  phoneNumber: z.string(),
+});
+
+export function pazeMobileNumberFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeMobileNumber, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeMobileNumber$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeMobileNumber' from JSON`,
+  );
+}

package/src/models/components/pazemobilesessioncreate.ts

@@ -0,0 +1,54 @@
+/*
+ * 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";
+
+export type PazeMobileSessionCreate = {
+  /**
+   * Session URL for launching the Paze checkout UI from the native mobile app.
+   */
+  pazeCheckoutUrl: string;
+  /**
+   * Merchant-defined transaction identifier echoed from the request.
+   */
+  clientContext: string;
+  /**
+   * Globally unique session identifier generated by Paze.
+   */
+  ewSID: string;
+  /**
+   * Timestamp when the response was sent by Paze, in ISO 8601 format.
+   */
+  timestampIso8601: string;
+};
+
+/** @internal */
+export const PazeMobileSessionCreate$inboundSchema: z.ZodType<
+  PazeMobileSessionCreate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pazeCheckoutUrl: z.string(),
+  clientContext: z.string(),
+  ewSID: z.string(),
+  timestampISO8601: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "timestampISO8601": "timestampIso8601",
+  });
+});
+
+export function pazeMobileSessionCreateFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeMobileSessionCreate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeMobileSessionCreate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeMobileSessionCreate' from JSON`,
+  );
+}

package/src/models/components/pazemobilesessioncreaterequest.ts

@@ -0,0 +1,212 @@
+/*
+ * 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";
+import {
+  PazeClient,
+  PazeClient$Outbound,
+  PazeClient$outboundSchema,
+} from "./pazeclient.js";
+import {
+  PazeCobrandItem,
+  PazeCobrandItem$Outbound,
+  PazeCobrandItem$outboundSchema,
+} from "./pazecobranditem.js";
+import {
+  PazeTransactionValue,
+  PazeTransactionValue$Outbound,
+  PazeTransactionValue$outboundSchema,
+} from "./pazetransactionvalue.js";
+
+/**
+ * Primary intent of the checkout session.
+ */
+export const Intent = {
+  ReviewAndPay: "REVIEW_AND_PAY",
+  ExpressCheckout: "EXPRESS_CHECKOUT",
+  AddCard: "ADD_CARD",
+} as const;
+/**
+ * Primary intent of the checkout session.
+ */
+export type Intent = OpenEnum<typeof Intent>;
+
+export const TransactionType = {
+  Purchase: "PURCHASE",
+  CardOnFile: "CARD_ON_FILE",
+  Both: "BOTH",
+} as const;
+export type TransactionType = OpenEnum<typeof TransactionType>;
+
+export const ShippingPreference = {
+  All: "ALL",
+  None: "NONE",
+} as const;
+export type ShippingPreference = OpenEnum<typeof ShippingPreference>;
+
+export const BillingPreference = {
+  All: "ALL",
+  ZipCountry: "ZIP_COUNTRY",
+  None: "NONE",
+} as const;
+export type BillingPreference = OpenEnum<typeof BillingPreference>;
+
+export const AcceptedPaymentCardNetworks = {
+  Visa: "VISA",
+  Mastercard: "MASTERCARD",
+} as const;
+export type AcceptedPaymentCardNetworks = OpenEnum<
+  typeof AcceptedPaymentCardNetworks
+>;
+
+export type PazeMobileSessionCreateRequest = {
+  client: PazeClient;
+  /**
+   * Session reference identifier generated by the merchant. Must be reused across all Paze APIs in a checkout session.
+   */
+  sessionId: string;
+  /**
+   * Access token obtained from the Paze session endpoint with source=mobile.
+   */
+  accessToken: string;
+  /**
+   * Merchant app's ID (iOS bundle identifier or Android application ID) used as the callback URL scheme.
+   */
+  callbackURLScheme: string;
+  /**
+   * Primary intent of the checkout session.
+   */
+  intent: Intent;
+  /**
+   * Currency and amount of the transaction. Required when intent is EXPRESS_CHECKOUT.
+   */
+  transactionValue?: PazeTransactionValue | null | undefined;
+  /**
+   * Type of transaction.
+   */
+  transactionType?: TransactionType | null | undefined;
+  /**
+   * Whether to collect a shipping address from the consumer.
+   */
+  shippingPreference?: ShippingPreference | null | undefined;
+  /**
+   * Verbosity of billing address required.
+   */
+  billingPreference?: BillingPreference | null | undefined;
+  /**
+   * Consumer email address for checkout flow optimization.
+   */
+  emailAddress?: string | null | undefined;
+  /**
+   * Consumer phone number for checkout flow optimization.
+   */
+  phoneNumber?: string | null | undefined;
+  /**
+   * Details for cobranded cards offered by the merchant.
+   */
+  cobrand?: Array<PazeCobrandItem> | null | undefined;
+  /**
+   * ISO 3166-1 alpha-2 country codes restricting eligible shipping addresses. Empty list or absence means all countries accepted.
+   */
+  acceptedShippingCountries?: Array<string> | null | undefined;
+  /**
+   * Accepted payment card networks. Empty list or absence means all networks accepted.
+   */
+  acceptedPaymentCardNetworks?:
+    | Array<AcceptedPaymentCardNetworks>
+    | null
+    | undefined;
+  /**
+   * Set to true to enable Paze checkout even if the provided email address or phone number does not match a Paze wallet.
+   */
+  alwaysEnableCheckout?: boolean | undefined;
+};
+
+/** @internal */
+export const Intent$outboundSchema: z.ZodType<string, z.ZodTypeDef, Intent> =
+  openEnums.outboundSchema(Intent);
+
+/** @internal */
+export const TransactionType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  TransactionType
+> = openEnums.outboundSchema(TransactionType);
+
+/** @internal */
+export const ShippingPreference$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ShippingPreference
+> = openEnums.outboundSchema(ShippingPreference);
+
+/** @internal */
+export const BillingPreference$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  BillingPreference
+> = openEnums.outboundSchema(BillingPreference);
+
+/** @internal */
+export const AcceptedPaymentCardNetworks$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AcceptedPaymentCardNetworks
+> = openEnums.outboundSchema(AcceptedPaymentCardNetworks);
+
+/** @internal */
+export type PazeMobileSessionCreateRequest$Outbound = {
+  client: PazeClient$Outbound;
+  sessionId: string;
+  accessToken: string;
+  callbackURLScheme: string;
+  intent: string;
+  transactionValue?: PazeTransactionValue$Outbound | null | undefined;
+  transactionType?: string | null | undefined;
+  shippingPreference?: string | null | undefined;
+  billingPreference?: string | null | undefined;
+  emailAddress?: string | null | undefined;
+  phoneNumber?: string | null | undefined;
+  cobrand?: Array<PazeCobrandItem$Outbound> | null | undefined;
+  acceptedShippingCountries?: Array<string> | null | undefined;
+  acceptedPaymentCardNetworks?: Array<string> | null | undefined;
+  alwaysEnableCheckout: boolean;
+};
+
+/** @internal */
+export const PazeMobileSessionCreateRequest$outboundSchema: z.ZodType<
+  PazeMobileSessionCreateRequest$Outbound,
+  z.ZodTypeDef,
+  PazeMobileSessionCreateRequest
+> = z.object({
+  client: PazeClient$outboundSchema,
+  sessionId: z.string(),
+  accessToken: z.string(),
+  callbackURLScheme: z.string(),
+  intent: Intent$outboundSchema,
+  transactionValue: z.nullable(PazeTransactionValue$outboundSchema).optional(),
+  transactionType: z.nullable(TransactionType$outboundSchema).optional(),
+  shippingPreference: z.nullable(ShippingPreference$outboundSchema).optional(),
+  billingPreference: z.nullable(BillingPreference$outboundSchema).optional(),
+  emailAddress: z.nullable(z.string()).optional(),
+  phoneNumber: z.nullable(z.string()).optional(),
+  cobrand: z.nullable(z.array(PazeCobrandItem$outboundSchema)).optional(),
+  acceptedShippingCountries: z.nullable(z.array(z.string())).optional(),
+  acceptedPaymentCardNetworks: z.nullable(
+    z.array(AcceptedPaymentCardNetworks$outboundSchema),
+  ).optional(),
+  alwaysEnableCheckout: z.boolean().default(false),
+});
+
+export function pazeMobileSessionCreateRequestToJSON(
+  pazeMobileSessionCreateRequest: PazeMobileSessionCreateRequest,
+): string {
+  return JSON.stringify(
+    PazeMobileSessionCreateRequest$outboundSchema.parse(
+      pazeMobileSessionCreateRequest,
+    ),
+  );
+}

package/src/models/components/pazesessionreview.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 { PazeConsumer, PazeConsumer$inboundSchema } from "./pazeconsumer.js";
+import {
+  PazeMaskedCard,
+  PazeMaskedCard$inboundSchema,
+} from "./pazemaskedcard.js";
+import {
+  PazeSessionReviewLinks,
+  PazeSessionReviewLinks$inboundSchema,
+} from "./pazesessionreviewlinks.js";
+import {
+  PazeShippingAddress,
+  PazeShippingAddress$inboundSchema,
+} from "./pazeshippingaddress.js";
+
+export type PazeSessionReview = {
+  consumer: PazeConsumer;
+  shippingAddress: PazeShippingAddress | null;
+  maskedCard: PazeMaskedCard;
+  links: PazeSessionReviewLinks;
+  /**
+   * Opaque token issued by the Paze service to be used in the next Paze interaction.
+   */
+  code: string;
+};
+
+/** @internal */
+export const PazeSessionReview$inboundSchema: z.ZodType<
+  PazeSessionReview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  consumer: PazeConsumer$inboundSchema,
+  shippingAddress: z.nullable(PazeShippingAddress$inboundSchema),
+  maskedCard: PazeMaskedCard$inboundSchema,
+  links: PazeSessionReviewLinks$inboundSchema,
+  code: z.string(),
+});
+
+export function pazeSessionReviewFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeSessionReview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeSessionReview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeSessionReview' from JSON`,
+  );
+}

package/src/models/components/pazesessionreviewlinks.ts

@@ -0,0 +1,45 @@
+/*
+ * 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";
+
+export type PazeSessionReviewLinks = {
+  /**
+   * Follow-up link to change the selected card.
+   */
+  changeCard: string | null;
+  /**
+   * Follow-up link to change the shipping address.
+   */
+  changeShippingAddress: string | null;
+};
+
+/** @internal */
+export const PazeSessionReviewLinks$inboundSchema: z.ZodType<
+  PazeSessionReviewLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  CHANGE_CARD: z.nullable(z.string()),
+  CHANGE_SHIPPING_ADDRESS: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "CHANGE_CARD": "changeCard",
+    "CHANGE_SHIPPING_ADDRESS": "changeShippingAddress",
+  });
+});
+
+export function pazeSessionReviewLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeSessionReviewLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeSessionReviewLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeSessionReviewLinks' from JSON`,
+  );
+}