@gr4vy/sdk 2.0.50 → 2.0.52

package/src/funcs/digitalWalletsSessionsPazeMobileSessionReview.ts

@@ -0,0 +1,232 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { Gr4vyCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { Gr4vyError } from "../models/errors/gr4vyerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Review a Paze session
+ *
+ * @remarks
+ * Review a Paze checkout session and retrieve the selected card, consumer, and shipping address details.
+ */
+export function digitalWalletsSessionsPazeMobileSessionReview(
+  client: Gr4vyCore,
+  pazeSessionReviewRequest: components.PazeSessionReviewRequest,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PazeSessionReview,
+    | errors.Error400
+    | errors.Error401
+    | errors.Error403
+    | errors.Error404
+    | errors.Error405
+    | errors.Error409
+    | errors.HTTPValidationError
+    | errors.Error425
+    | errors.Error429
+    | errors.Error500
+    | errors.Error502
+    | errors.Error504
+    | Gr4vyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    pazeSessionReviewRequest,
+    merchantAccountId,
+    options,
+  ));
+}
+
+async function $do(
+  client: Gr4vyCore,
+  pazeSessionReviewRequest: components.PazeSessionReviewRequest,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PazeSessionReview,
+      | errors.Error400
+      | errors.Error401
+      | errors.Error403
+      | errors.Error404
+      | errors.Error405
+      | errors.Error409
+      | errors.HTTPValidationError
+      | errors.Error425
+      | errors.Error429
+      | errors.Error500
+      | errors.Error502
+      | errors.Error504
+      | Gr4vyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.ReviewPazeMobileSessionRequest = {
+    pazeSessionReviewRequest: pazeSessionReviewRequest,
+    merchantAccountId: merchantAccountId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.ReviewPazeMobileSessionRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.PazeSessionReviewRequest, {
+    explode: true,
+  });
+
+  const path = pathToFunc("/digital-wallets/paze/session/review")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+    "x-gr4vy-merchant-account-id": encodeSimple(
+      "x-gr4vy-merchant-account-id",
+      payload.merchantAccountId ?? client._options.merchantAccountId,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "review_paze_mobile_session",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.PazeSessionReview,
+    | errors.Error400
+    | errors.Error401
+    | errors.Error403
+    | errors.Error404
+    | errors.Error405
+    | errors.Error409
+    | errors.HTTPValidationError
+    | errors.Error425
+    | errors.Error429
+    | errors.Error500
+    | errors.Error502
+    | errors.Error504
+    | Gr4vyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.PazeSessionReview$inboundSchema),
+    M.jsonErr(400, errors.Error400$inboundSchema),
+    M.jsonErr(401, errors.Error401$inboundSchema),
+    M.jsonErr(403, errors.Error403$inboundSchema),
+    M.jsonErr(404, errors.Error404$inboundSchema),
+    M.jsonErr(405, errors.Error405$inboundSchema),
+    M.jsonErr(409, errors.Error409$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.jsonErr(425, errors.Error425$inboundSchema),
+    M.jsonErr(429, errors.Error429$inboundSchema),
+    M.jsonErr(500, errors.Error500$inboundSchema),
+    M.jsonErr(502, errors.Error502$inboundSchema),
+    M.jsonErr(504, errors.Error504$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -77,7 +77,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "2.0.50",
+  sdkVersion: "2.0.52",
   genVersion: "2.884.11",
-  userAgent: "speakeasy-sdk/typescript 2.0.50 2.884.11 1.0.0 @gr4vy/sdk",
+  userAgent: "speakeasy-sdk/typescript 2.0.52 2.884.11 1.0.0 @gr4vy/sdk",
 } as const;

package/src/models/components/index.ts

@@ -207,9 +207,19 @@ export * from "./paypaloptions.js";
 export * from "./paypalshippingoptions.js";
 export * from "./paypalshippingoptionsitem.js";
 export * from "./paypalshippingoptionsitemamount.js";
+export * from "./pazebillingaddress.js";
+export * from "./pazeconsumer.js";
+export * from "./pazedeliverycontactdetails.js";
+export * from "./pazedigitalcarddata.js";
+export * from "./pazemaskedcard.js";
+export * from "./pazemobilenumber.js";
 export * from "./pazemobilesession.js";
 export * from "./pazepaymentmethodcreate.js";
 export * from "./pazesessionrequest.js";
+export * from "./pazesessionreview.js";
+export * from "./pazesessionreviewlinks.js";
+export * from "./pazesessionreviewrequest.js";
+export * from "./pazeshippingaddress.js";
 export * from "./pazewebsession.js";
 export * from "./plaidpaymentmethodcreate.js";
 export * from "./powertranzoptions.js";

package/src/models/components/paymentmethod.ts

@@ -113,6 +113,10 @@ export type PaymentMethod = {
    * The scheme associated with scheme_transaction_id. Only applies to card payments.
    */
   schemeTransactionIdScheme: CardScheme | null;
+  /**
+   * The transaction link identifier stored against this payment method.
+   */
+  transactionLinkId?: string | null | undefined;
   /**
    * The optional buyer for which this payment method has been stored.
    */
@@ -166,6 +170,7 @@ export const PaymentMethod$inboundSchema: z.ZodType<
   usage_count: z.number().int(),
   scheme_transaction_id: z.nullable(z.string()),
   scheme_transaction_id_scheme: z.nullable(CardScheme$inboundSchema),
+  transaction_link_id: z.nullable(z.string()).optional(),
   buyer: z.nullable(Buyer$inboundSchema).optional(),
   external_identifier: z.nullable(z.string()).optional(),
   status: PaymentMethodStatus$inboundSchema,
@@ -185,6 +190,7 @@ export const PaymentMethod$inboundSchema: z.ZodType<
     "usage_count": "usageCount",
     "scheme_transaction_id": "schemeTransactionId",
     "scheme_transaction_id_scheme": "schemeTransactionIdScheme",
+    "transaction_link_id": "transactionLinkId",
     "external_identifier": "externalIdentifier",
     "created_at": "createdAt",
     "updated_at": "updatedAt",

package/src/models/components/paymentmethodsummary.ts

@@ -108,6 +108,10 @@ export type PaymentMethodSummary = {
    * The scheme associated with scheme_transaction_id. Only applies to card payments.
    */
   schemeTransactionIdScheme: CardScheme | null;
+  /**
+   * The transaction link identifier stored against this payment method.
+   */
+  transactionLinkId?: string | null | undefined;
 };
 
 /** @internal */
@@ -144,6 +148,7 @@ export const PaymentMethodSummary$inboundSchema: z.ZodType<
   usage_count: z.number().int(),
   scheme_transaction_id: z.nullable(z.string()),
   scheme_transaction_id_scheme: z.nullable(CardScheme$inboundSchema),
+  transaction_link_id: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "approval_url": "approvalUrl",
@@ -158,6 +163,7 @@ export const PaymentMethodSummary$inboundSchema: z.ZodType<
     "usage_count": "usageCount",
     "scheme_transaction_id": "schemeTransactionId",
     "scheme_transaction_id_scheme": "schemeTransactionIdScheme",
+    "transaction_link_id": "transactionLinkId",
   });
 });
 

package/src/models/components/pazebillingaddress.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 PazeBillingAddress = {
+  /**
+   * Name of the organization or entity at the address.
+   */
+  name: string | null;
+  /**
+   * 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 | null;
+};
+
+/** @internal */
+export const PazeBillingAddress$inboundSchema: z.ZodType<
+  PazeBillingAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.nullable(z.string()),
+  line1: z.string(),
+  line2: z.nullable(z.string()),
+  line3: z.nullable(z.string()),
+  city: z.string(),
+  state: z.string(),
+  zip: z.string(),
+  countryCode: z.nullable(z.string()),
+});
+
+export function pazeBillingAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<PazeBillingAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PazeBillingAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PazeBillingAddress' from JSON`,
+  );
+}

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