@gr4vy/sdk 2.0.51 → 2.0.52

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

package/src/models/components/pazesessionreviewrequest.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type PazeSessionReviewRequest = {
+  /**
+   * Session reference identifier generated by the merchant. Must match the value sent in the Paze session create call.
+   */
+  sessionId: string;
+  /**
+   * Opaque token issued by the Paze service in the response from the most recent Paze UX interaction (checkout, change card, or change shipping address).
+   */
+  code: string;
+  /**
+   * The Paze OAuth access token returned by the Paze mobile session create call. Used to authenticate the request to Paze.
+   */
+  accessToken: string;
+};
+
+/** @internal */
+export type PazeSessionReviewRequest$Outbound = {
+  sessionId: string;
+  code: string;
+  accessToken: string;
+};
+
+/** @internal */
+export const PazeSessionReviewRequest$outboundSchema: z.ZodType<
+  PazeSessionReviewRequest$Outbound,
+  z.ZodTypeDef,
+  PazeSessionReviewRequest
+> = z.object({
+  sessionId: z.string(),
+  code: z.string(),
+  accessToken: z.string(),
+});
+
+export function pazeSessionReviewRequestToJSON(
+  pazeSessionReviewRequest: PazeSessionReviewRequest,
+): string {
+  return JSON.stringify(
+    PazeSessionReviewRequest$outboundSchema.parse(pazeSessionReviewRequest),
+  );
+}

package/src/models/components/pazeshippingaddress.ts

@@ -0,0 +1,70 @@
+/*
+ * 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 {
+  PazeDeliveryContactDetails,
+  PazeDeliveryContactDetails$inboundSchema,
+} from "./pazedeliverycontactdetails.js";
+
+export type PazeShippingAddress = {
+  /**
+   * Line 1 of the address.
+   */
+  line1: string;
+  /**
+   * Line 2 of the address.
+   */
+  line2: string | null;
+  /**
+   * Line 3 of the address.
+   */
+  line3: string | null;
+  /**
+   * City.
+   */
+  city: string;
+  /**
+   * State or region.
+   */
+  state: string;
+  /**
+   * Postal code.
+   */
+  zip: string;
+  /**
+   * ISO 3166-1 alpha-2 country code.
+   */
+  countryCode: string;
+  deliveryContactDetails: PazeDeliveryContactDetails | null;
+};
+
+/** @internal */
+export const PazeShippingAddress$inboundSchema: z.ZodType<
+  PazeShippingAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  line1: z.string(),
+  line2: z.nullable(z.string()),
+  line3: z.nullable(z.string()),
+  city: z.string(),
+  state: z.string(),
+  zip: z.string(),
+  countryCode: z.string(),
+  deliveryContactDetails: z.nullable(PazeDeliveryContactDetails$inboundSchema),
+});
+
+export function pazeShippingAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeShippingAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeShippingAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeShippingAddress' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -89,6 +89,7 @@ export * from "./listtransactions.js";
 export * from "./listtransactionsettlements.js";
 export * from "./registerdigitalwalletdomain.js";
 export * from "./resumepaymentmethodnetworktoken.js";
+export * from "./reviewpazemobilesession.js";
 export * from "./suspendpaymentmethodnetworktoken.js";
 export * from "./synctransaction.js";
 export * from "./unregisterdigitalwalletdomain.js";

package/src/models/operations/reviewpazemobilesession.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 * as components from "../components/index.js";
+
+export type ReviewPazeMobileSessionGlobals = {
+  merchantAccountId?: string | undefined;
+};
+
+export type ReviewPazeMobileSessionRequest = {
+  /**
+   * The ID of the merchant account to use for this request.
+   */
+  merchantAccountId?: string | null | undefined;
+  pazeSessionReviewRequest: components.PazeSessionReviewRequest;
+};
+
+/** @internal */
+export type ReviewPazeMobileSessionRequest$Outbound = {
+  merchantAccountId?: string | null | undefined;
+  PazeSessionReviewRequest: components.PazeSessionReviewRequest$Outbound;
+};
+
+/** @internal */
+export const ReviewPazeMobileSessionRequest$outboundSchema: z.ZodType<
+  ReviewPazeMobileSessionRequest$Outbound,
+  z.ZodTypeDef,
+  ReviewPazeMobileSessionRequest
+> = z.object({
+  merchantAccountId: z.nullable(z.string()).optional(),
+  pazeSessionReviewRequest: components.PazeSessionReviewRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    pazeSessionReviewRequest: "PazeSessionReviewRequest",
+  });
+});
+
+export function reviewPazeMobileSessionRequestToJSON(
+  reviewPazeMobileSessionRequest: ReviewPazeMobileSessionRequest,
+): string {
+  return JSON.stringify(
+    ReviewPazeMobileSessionRequest$outboundSchema.parse(
+      reviewPazeMobileSessionRequest,
+    ),
+  );
+}

package/src/sdk/sessions.ts

@@ -6,6 +6,7 @@ import { digitalWalletsSessionsApplePay } from "../funcs/digitalWalletsSessionsA
 import { digitalWalletsSessionsClickToPay } from "../funcs/digitalWalletsSessionsClickToPay.js";
 import { digitalWalletsSessionsGooglePay } from "../funcs/digitalWalletsSessionsGooglePay.js";
 import { digitalWalletsSessionsPaze } from "../funcs/digitalWalletsSessionsPaze.js";
+import { digitalWalletsSessionsPazeMobileSessionReview } from "../funcs/digitalWalletsSessionsPazeMobileSessionReview.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -71,6 +72,25 @@ export class Sessions extends ClientSDK {
     ));
   }
 
+  /**
+   * Review a Paze session
+   *
+   * @remarks
+   * Review a Paze checkout session and retrieve the selected card, consumer, and shipping address details.
+   */
+  async pazeMobileSessionReview(
+    pazeSessionReviewRequest: components.PazeSessionReviewRequest,
+    merchantAccountId?: string | null | undefined,
+    options?: RequestOptions,
+  ): Promise<components.PazeSessionReview> {
+    return unwrapAsync(digitalWalletsSessionsPazeMobileSessionReview(
+      this,
+      pazeSessionReviewRequest,
+      merchantAccountId,
+      options,
+    ));
+  }
+
   /**
    * Create a Click to Pay session
    *