@gr4vy/sdk 2.0.52 → 2.0.54

package/src/funcs/digitalWalletsSessionsPazeMobileSessionCreate.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";
+
+/**
+ * Create a Paze mobile session
+ *
+ * @remarks
+ * Create a mobile session for use with Paze.
+ */
+export function digitalWalletsSessionsPazeMobileSessionCreate(
+  client: Gr4vyCore,
+  pazeMobileSessionCreateRequest: components.PazeMobileSessionCreateRequest,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PazeMobileSessionCreate,
+    | 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,
+    pazeMobileSessionCreateRequest,
+    merchantAccountId,
+    options,
+  ));
+}
+
+async function $do(
+  client: Gr4vyCore,
+  pazeMobileSessionCreateRequest: components.PazeMobileSessionCreateRequest,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PazeMobileSessionCreate,
+      | 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.CreatePazeMobileSessionRequest = {
+    pazeMobileSessionCreateRequest: pazeMobileSessionCreateRequest,
+    merchantAccountId: merchantAccountId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.CreatePazeMobileSessionRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.PazeMobileSessionCreateRequest, {
+    explode: true,
+  });
+
+  const path = pathToFunc("/digital-wallets/paze/session/create")();
+
+  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: "create_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.PazeMobileSessionCreate,
+    | 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.PazeMobileSessionCreate$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.52",
-  genVersion: "2.884.11",
-  userAgent: "speakeasy-sdk/typescript 2.0.52 2.884.11 1.0.0 @gr4vy/sdk",
+  sdkVersion: "2.0.54",
+  genVersion: "2.887.0",
+  userAgent: "speakeasy-sdk/typescript 2.0.54 2.887.0 1.0.0 @gr4vy/sdk",
 } as const;

package/src/models/components/definitionfield.ts

@@ -33,6 +33,10 @@ export type DefinitionField = {
    * Defines if this field is secret. When `true` the field's value is not returned when querying the payment service information.
    */
   secret: boolean;
+  /**
+   * Defines if this field can be verified through the verify credentials button.
+   */
+  verifiable: boolean;
 };
 
 /** @internal */
@@ -46,6 +50,7 @@ export const DefinitionField$inboundSchema: z.ZodType<
   required: z.boolean(),
   format: DefinitionFieldFormat$inboundSchema,
   secret: z.boolean(),
+  verifiable: z.boolean(),
 }).transform((v) => {
   return remap$(v, {
     "display_name": "displayName",

package/src/models/components/index.ts

@@ -208,18 +208,23 @@ export * from "./paypalshippingoptions.js";
 export * from "./paypalshippingoptionsitem.js";
 export * from "./paypalshippingoptionsitemamount.js";
 export * from "./pazebillingaddress.js";
+export * from "./pazeclient.js";
+export * from "./pazecobranditem.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 "./pazemobilesessioncreate.js";
+export * from "./pazemobilesessioncreaterequest.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 "./pazetransactionvalue.js";
 export * from "./pazewebsession.js";
 export * from "./plaidpaymentmethodcreate.js";
 export * from "./powertranzoptions.js";

package/src/models/components/pazeclient.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type PazeClient = {
+  /**
+   * Client identifier generated by Paze and shared during onboarding.
+   */
+  id: string;
+  /**
+   * Display name associated with the client for presentation purposes.
+   */
+  name?: string | null | undefined;
+  /**
+   * Client profile to use during checkout.
+   */
+  profileId?: string | null | undefined;
+};
+
+/** @internal */
+export type PazeClient$Outbound = {
+  id: string;
+  name?: string | null | undefined;
+  profileId?: string | null | undefined;
+};
+
+/** @internal */
+export const PazeClient$outboundSchema: z.ZodType<
+  PazeClient$Outbound,
+  z.ZodTypeDef,
+  PazeClient
+> = z.object({
+  id: z.string(),
+  name: z.nullable(z.string()).optional(),
+  profileId: z.nullable(z.string()).optional(),
+});
+
+export function pazeClientToJSON(pazeClient: PazeClient): string {
+  return JSON.stringify(PazeClient$outboundSchema.parse(pazeClient));
+}

package/src/models/components/pazecobranditem.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type PazeCobrandItem = {
+  /**
+   * Product name of the cobrand card. Must match exactly with the card name from the network.
+   */
+  name: string;
+  /**
+   * Whether benefits are offered for this cobrand card.
+   */
+  benefitsOffered?: boolean | null | undefined;
+};
+
+/** @internal */
+export type PazeCobrandItem$Outbound = {
+  name: string;
+  benefitsOffered?: boolean | null | undefined;
+};
+
+/** @internal */
+export const PazeCobrandItem$outboundSchema: z.ZodType<
+  PazeCobrandItem$Outbound,
+  z.ZodTypeDef,
+  PazeCobrandItem
+> = z.object({
+  name: z.string(),
+  benefitsOffered: z.nullable(z.boolean()).optional(),
+});
+
+export function pazeCobrandItemToJSON(
+  pazeCobrandItem: PazeCobrandItem,
+): string {
+  return JSON.stringify(PazeCobrandItem$outboundSchema.parse(pazeCobrandItem));
+}

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/pazetransactionvalue.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type PazeTransactionValue = {
+  /**
+   * ISO 4217 currency code of the transaction.
+   */
+  transactionCurrency: string;
+  /**
+   * Amount of the transaction including dollar and cents, e.g. '99.95'.
+   */
+  transactionAmount: string;
+};
+
+/** @internal */
+export type PazeTransactionValue$Outbound = {
+  transactionCurrency: string;
+  transactionAmount: string;
+};
+
+/** @internal */
+export const PazeTransactionValue$outboundSchema: z.ZodType<
+  PazeTransactionValue$Outbound,
+  z.ZodTypeDef,
+  PazeTransactionValue
+> = z.object({
+  transactionCurrency: z.string(),
+  transactionAmount: z.string(),
+});
+
+export function pazeTransactionValueToJSON(
+  pazeTransactionValue: PazeTransactionValue,
+): string {
+  return JSON.stringify(
+    PazeTransactionValue$outboundSchema.parse(pazeTransactionValue),
+  );
+}