@gr4vy/sdk 1.7.1 → 1.9.0

package/src/funcs/transactionsEventsList.ts

@@ -3,6 +3,7 @@
  */
 
 import { Gr4vyCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -10,7 +11,6 @@ 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,
@@ -25,6 +25,12 @@ 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";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
 
 /**
  * List transaction events
@@ -40,51 +46,9 @@ export function transactionsEventsList(
   merchantAccountId?: string | null | undefined,
   options?: RequestOptions,
 ): APIPromise<
-  Result<
-    components.TransactionEvents,
-    | 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,
-    transactionId,
-    cursor,
-    limit,
-    merchantAccountId,
-    options,
-  ));
-}
-
-async function $do(
-  client: Gr4vyCore,
-  transactionId: string,
-  cursor?: string | null | undefined,
-  limit?: number | undefined,
-  merchantAccountId?: string | null | undefined,
-  options?: RequestOptions,
-): Promise<
-  [
+  PageIterator<
     Result<
-      components.TransactionEvents,
+      operations.ListTransactionEventsResponse,
       | errors.Error400
       | errors.Error401
       | errors.Error403
@@ -106,6 +70,54 @@ async function $do(
       | UnexpectedClientError
       | SDKValidationError
     >,
+    { cursor: string }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    transactionId,
+    cursor,
+    limit,
+    merchantAccountId,
+    options,
+  ));
+}
+
+async function $do(
+  client: Gr4vyCore,
+  transactionId: string,
+  cursor?: string | null | undefined,
+  limit?: number | undefined,
+  merchantAccountId?: string | null | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListTransactionEventsResponse,
+        | 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
+      >,
+      { cursor: string }
+    >,
     APICall,
   ]
 > {
@@ -123,7 +135,7 @@ async function $do(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
+    return [haltIterator(parsed), { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -192,7 +204,7 @@ async function $do(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
+    return [haltIterator(requestRes), { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -218,7 +230,7 @@ async function $do(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req }];
+    return [haltIterator(doResult), { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -226,8 +238,8 @@ async function $do(
     HttpMeta: { Response: response, Request: req },
   };
 
-  const [result] = await M.match<
-    components.TransactionEvents,
+  const [result, raw] = await M.match<
+    operations.ListTransactionEventsResponse,
     | errors.Error400
     | errors.Error401
     | errors.Error403
@@ -249,7 +261,9 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.TransactionEvents$inboundSchema),
+    M.json(200, operations.ListTransactionEventsResponse$inboundSchema, {
+      key: "Result",
+    }),
     M.jsonErr(400, errors.Error400$inboundSchema),
     M.jsonErr(401, errors.Error401$inboundSchema),
     M.jsonErr(403, errors.Error403$inboundSchema),
@@ -266,8 +280,68 @@ async function $do(
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
-    return [result, { status: "complete", request: req, response }];
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
   }
 
-  return [result, { status: "complete", request: req, response }];
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListTransactionEventsResponse,
+        | 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
+      >
+    >;
+    "~next"?: { cursor: string };
+  } => {
+    const nextCursor = dlv(responseData, "next_cursor");
+    if (typeof nextCursor !== "string") {
+      return { next: () => null };
+    }
+    if (nextCursor.trim() === "") {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      transactionsEventsList(
+        client,
+        transactionId,
+        nextCursor,
+        limit,
+        merchantAccountId,
+        options,
+      );
+
+    return { next: nextVal, "~next": { cursor: nextCursor } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    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: "1.7.1",
-  genVersion: "2.763.3",
-  userAgent: "speakeasy-sdk/typescript 1.7.1 2.763.3 1.0.0 @gr4vy/sdk",
+  sdkVersion: "1.9.0",
+  genVersion: "2.770.0",
+  userAgent: "speakeasy-sdk/typescript 1.9.0 2.770.0 1.0.0 @gr4vy/sdk",
 } as const;

package/src/lib/encodings.ts

@@ -427,6 +427,7 @@ export function queryJoin(...args: (string | undefined)[]): string {
 type QueryEncoderOptions = {
   explode?: boolean;
   charEncoding?: "percent" | "none";
+  allowEmptyValue?: string[];
 };
 
 type QueryEncoder = (
@@ -451,7 +452,19 @@ export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
       charEncoding: options?.charEncoding ?? "percent",
     };
 
+    const allowEmptySet = new Set(options?.allowEmptyValue ?? []);
+
     const encoded = Object.entries(values).map(([key, value]) => {
+      if (allowEmptySet.has(key)) {
+        if (
+          value === undefined
+          || value === null
+          || value === ""
+          || (Array.isArray(value) && value.length === 0)
+        ) {
+          return `${encodeURIComponent(key)}=`;
+        }
+      }
       return f(key, value, opts);
     });
     return queryJoin(...encoded);

package/src/models/components/accountsreceivablesreportspec.ts

@@ -8,7 +8,7 @@ export type AccountsReceivablesReportSpec = {
   /**
    * The report model type.
    */
-  model?: "accounts_receivables" | undefined;
+  model: "accounts_receivables";
   /**
    * The parameters for the accounts receivables report model.
    */
@@ -27,9 +27,7 @@ export const AccountsReceivablesReportSpec$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AccountsReceivablesReportSpec
 > = z.object({
-  model: z.literal("accounts_receivables").default(
-    "accounts_receivables" as const,
-  ),
+  model: z.literal("accounts_receivables"),
   params: z.record(z.any()),
 });
 

package/src/models/components/accountupdateroptions.ts

@@ -30,7 +30,7 @@ export type AccountUpdaterOptions = {
 
 /** @internal */
 export type AccountUpdaterOptions$Outbound = {
-  response_code: "updated" | null;
+  response_code?: "updated" | null | undefined;
   account_number?: string | null | undefined;
   expiration_month?: string | null | undefined;
   expiration_year?: string | null | undefined;
@@ -43,7 +43,7 @@ export const AccountUpdaterOptions$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AccountUpdaterOptions
 > = z.object({
-  responseCode: z.nullable(z.literal("updated")),
+  responseCode: z.nullable(z.literal("updated")).optional(),
   accountNumber: z.nullable(z.string()).optional(),
   expirationMonth: z.nullable(z.string()).optional(),
   expirationYear: z.nullable(z.string()).optional(),

package/src/models/components/applepaypaymentmethodcreate.ts

@@ -40,7 +40,7 @@ export type ApplePayPaymentMethodCreate = {
   /**
    * Always `applepay`
    */
-  method?: "applepay" | undefined;
+  method: "applepay";
   /**
    * The opaque token as received from the Apple Pay JS library. This format may change between JS library versions.
    */

package/src/models/components/clicktopayfpanpaymentmethodcreate.ts

@@ -36,7 +36,7 @@ export type ClickToPayFPANPaymentMethodCreate = {
   /**
    * Aways `click-to-pay`.
    */
-  method?: "click-to-pay" | undefined;
+  method: "click-to-pay";
   /**
    * The URL to redirect a user back to after the complete 3DS in browser.
    */

package/src/models/components/clicktopaypaymentmethodcreate.ts

@@ -16,7 +16,7 @@ export type ClickToPayPaymentMethodCreate = {
   /**
    * Aways `click-to-pay`.
    */
-  method?: "click-to-pay" | undefined;
+  method: "click-to-pay";
   /**
    * The device token.
    */

package/src/models/components/detailedsettlementreportspec.ts

@@ -8,7 +8,7 @@ export type DetailedSettlementReportSpec = {
   /**
    * The report model type.
    */
-  model?: "detailed_settlement" | undefined;
+  model: "detailed_settlement";
   /**
    * The parameters for the detailed settlement report model.
    */
@@ -27,9 +27,7 @@ export const DetailedSettlementReportSpec$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   DetailedSettlementReportSpec
 > = z.object({
-  model: z.literal("detailed_settlement").default(
-    "detailed_settlement" as const,
-  ),
+  model: z.literal("detailed_settlement"),
   params: z.record(z.any()),
 });
 

package/src/models/components/googlepayfpanpaymentmethodcreate.ts

@@ -36,7 +36,7 @@ export type GooglePayFPANPaymentMethodCreate = {
   /**
    * Aways `googlepay_pan_only`.
    */
-  method?: "googlepay_pan_only" | undefined;
+  method: "googlepay_pan_only";
   /**
    * The URL to redirect a user back to after the complete 3DS in browser.
    */

package/src/models/components/googlepaypaymentmethodcreate.ts

@@ -50,7 +50,7 @@ export type GooglePayPaymentMethodCreate = {
   /**
    * Always `googlepay`
    */
-  method?: "googlepay" | undefined;
+  method: "googlepay";
   /**
    * The opaque token as received from the Google Pay JS library. This format may change between JS library versions.
    */

package/src/models/components/index.ts

@@ -237,7 +237,6 @@ export * from "./transactioncapturecreate.js";
 export * from "./transactionconnectionoptions.js";
 export * from "./transactioncreate.js";
 export * from "./transactionevent.js";
-export * from "./transactioneventcontext.js";
 export * from "./transactionevents.js";
 export * from "./transactiongiftcard.js";
 export * from "./transactionintent.js";

package/src/models/components/networktokenpaymentmethodcreate.ts

@@ -18,7 +18,7 @@ export type NetworkTokenPaymentMethodCreate = {
   /**
    * Always `network-token`.
    */
-  method?: "network-token" | undefined;
+  method: "network-token";
   /**
    * The scheme token.
    */

package/src/models/components/paymentlink.ts

@@ -140,6 +140,14 @@ export type PaymentLink = {
    * The connection options for the payment link.
    */
   connectionOptions?: { [k: string]: { [k: string]: any } } | null | undefined;
+  /**
+   * Whether the payment method was stored.
+   */
+  store?: boolean | undefined;
+  /**
+   * The ID of the buyer to associate with the stored payment method.
+   */
+  buyerId?: string | null | undefined;
 };
 
 /** @internal */
@@ -179,6 +187,8 @@ export const PaymentLink$inboundSchema: z.ZodType<
   buyer: z.nullable(TransactionBuyer$inboundSchema).optional(),
   shipping_details: z.nullable(ShippingDetails$inboundSchema).optional(),
   connection_options: z.nullable(z.record(z.record(z.any()))).optional(),
+  store: z.boolean().default(false),
+  buyer_id: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "expires_at": "expiresAt",
@@ -198,6 +208,7 @@ export const PaymentLink$inboundSchema: z.ZodType<
     "updated_at": "updatedAt",
     "shipping_details": "shippingDetails",
     "connection_options": "connectionOptions",
+    "buyer_id": "buyerId",
   });
 });
 

package/src/models/components/paymentlinkcreate.ts

@@ -115,6 +115,14 @@ export type PaymentLinkCreate = {
    * The way payment method information made it to this transaction.
    */
   paymentSource?: TransactionPaymentSource | undefined;
+  /**
+   * Whether to store the payment method for future use.
+   */
+  store?: boolean | undefined;
+  /**
+   * The ID of the buyer to associate the payment method with. Note: When `buyer_id` is provided, the payment link should be treated as a secret as it will allow the user to manage payment methods for the associated buyer.
+   */
+  buyerId?: string | null | undefined;
 };
 
 /** @internal */
@@ -140,6 +148,8 @@ export type PaymentLinkCreate$Outbound = {
   cart_items?: Array<CartItem$Outbound> | null | undefined;
   metadata?: { [k: string]: any } | null | undefined;
   payment_source?: string | undefined;
+  store: boolean;
+  buyer_id?: string | null | undefined;
 };
 
 /** @internal */
@@ -171,6 +181,8 @@ export const PaymentLinkCreate$outboundSchema: z.ZodType<
   cartItems: z.nullable(z.array(CartItem$outboundSchema)).optional(),
   metadata: z.nullable(z.record(z.any())).optional(),
   paymentSource: TransactionPaymentSource$outboundSchema.optional(),
+  store: z.boolean().default(false),
+  buyerId: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     expiresAt: "expires_at",
@@ -187,6 +199,7 @@ export const PaymentLinkCreate$outboundSchema: z.ZodType<
     returnUrl: "return_url",
     cartItems: "cart_items",
     paymentSource: "payment_source",
+    buyerId: "buyer_id",
   });
 });
 

package/src/models/components/reportcreate.ts

@@ -33,10 +33,10 @@ import {
  * The report specification.
  */
 export type Spec =
-  | (AccountsReceivablesReportSpec & { model: "accounts_receivables" })
-  | (DetailedSettlementReportSpec & { model: "detailed_settlement" })
-  | (TransactionRetriesReportSpec & { model: "transaction_retries" })
-  | (TransactionsReportSpec & { model: "transactions" });
+  | AccountsReceivablesReportSpec
+  | DetailedSettlementReportSpec
+  | TransactionRetriesReportSpec
+  | TransactionsReportSpec;
 
 export type ReportCreate = {
   /**
@@ -60,34 +60,26 @@ export type ReportCreate = {
    * The report specification.
    */
   spec:
-    | (AccountsReceivablesReportSpec & { model: "accounts_receivables" })
-    | (DetailedSettlementReportSpec & { model: "detailed_settlement" })
-    | (TransactionRetriesReportSpec & { model: "transaction_retries" })
-    | (TransactionsReportSpec & { model: "transactions" });
+    | AccountsReceivablesReportSpec
+    | DetailedSettlementReportSpec
+    | TransactionRetriesReportSpec
+    | TransactionsReportSpec;
 };
 
 /** @internal */
 export type Spec$Outbound =
-  | (AccountsReceivablesReportSpec$Outbound & { model: "accounts_receivables" })
-  | (DetailedSettlementReportSpec$Outbound & { model: "detailed_settlement" })
-  | (TransactionRetriesReportSpec$Outbound & { model: "transaction_retries" })
-  | (TransactionsReportSpec$Outbound & { model: "transactions" });
+  | AccountsReceivablesReportSpec$Outbound
+  | DetailedSettlementReportSpec$Outbound
+  | TransactionRetriesReportSpec$Outbound
+  | TransactionsReportSpec$Outbound;
 
 /** @internal */
 export const Spec$outboundSchema: z.ZodType<Spec$Outbound, z.ZodTypeDef, Spec> =
   z.union([
-    AccountsReceivablesReportSpec$outboundSchema.and(
-      z.object({ model: z.literal("accounts_receivables") }),
-    ),
-    DetailedSettlementReportSpec$outboundSchema.and(
-      z.object({ model: z.literal("detailed_settlement") }),
-    ),
-    TransactionRetriesReportSpec$outboundSchema.and(
-      z.object({ model: z.literal("transaction_retries") }),
-    ),
-    TransactionsReportSpec$outboundSchema.and(
-      z.object({ model: z.literal("transactions") }),
-    ),
+    AccountsReceivablesReportSpec$outboundSchema,
+    DetailedSettlementReportSpec$outboundSchema,
+    TransactionRetriesReportSpec$outboundSchema,
+    TransactionsReportSpec$outboundSchema,
   ]);
 
 export function specToJSON(spec: Spec): string {
@@ -102,12 +94,10 @@ export type ReportCreate$Outbound = {
   schedule_enabled: boolean;
   schedule_timezone: string;
   spec:
-    | (AccountsReceivablesReportSpec$Outbound & {
-      model: "accounts_receivables";
-    })
-    | (DetailedSettlementReportSpec$Outbound & { model: "detailed_settlement" })
-    | (TransactionRetriesReportSpec$Outbound & { model: "transaction_retries" })
-    | (TransactionsReportSpec$Outbound & { model: "transactions" });
+    | AccountsReceivablesReportSpec$Outbound
+    | DetailedSettlementReportSpec$Outbound
+    | TransactionRetriesReportSpec$Outbound
+    | TransactionsReportSpec$Outbound;
 };
 
 /** @internal */
@@ -122,18 +112,10 @@ export const ReportCreate$outboundSchema: z.ZodType<
   scheduleEnabled: z.boolean(),
   scheduleTimezone: z.string().default("Etc/UTC"),
   spec: z.union([
-    AccountsReceivablesReportSpec$outboundSchema.and(
-      z.object({ model: z.literal("accounts_receivables") }),
-    ),
-    DetailedSettlementReportSpec$outboundSchema.and(
-      z.object({ model: z.literal("detailed_settlement") }),
-    ),
-    TransactionRetriesReportSpec$outboundSchema.and(
-      z.object({ model: z.literal("transaction_retries") }),
-    ),
-    TransactionsReportSpec$outboundSchema.and(
-      z.object({ model: z.literal("transactions") }),
-    ),
+    AccountsReceivablesReportSpec$outboundSchema,
+    DetailedSettlementReportSpec$outboundSchema,
+    TransactionRetriesReportSpec$outboundSchema,
+    TransactionsReportSpec$outboundSchema,
   ]),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/transactionevent.ts

@@ -9,10 +9,6 @@ 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 {
-  TransactionEventContext,
-  TransactionEventContext$inboundSchema,
-} from "./transactioneventcontext.js";
 
 /**
  * The specific event name.
@@ -115,7 +111,7 @@ export type TransactionEvent = {
    * The date this event was created at.
    */
   createdAt: Date;
-  context: TransactionEventContext;
+  context: { [k: string]: any };
 };
 
 /** @internal */
@@ -132,7 +128,7 @@ export const TransactionEvent$inboundSchema: z.ZodType<
   id: z.string(),
   name: Name$inboundSchema,
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  context: TransactionEventContext$inboundSchema,
+  context: z.record(z.any()),
 }).transform((v) => {
   return remap$(v, {
     "created_at": "createdAt",

package/src/models/components/transactionretriesreportspec.ts

@@ -8,7 +8,7 @@ export type TransactionRetriesReportSpec = {
   /**
    * The report model type.
    */
-  model?: "transaction_retries" | undefined;
+  model: "transaction_retries";
   /**
    * The parameters for the transaction retries report model.
    */
@@ -27,9 +27,7 @@ export const TransactionRetriesReportSpec$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TransactionRetriesReportSpec
 > = z.object({
-  model: z.literal("transaction_retries").default(
-    "transaction_retries" as const,
-  ),
+  model: z.literal("transaction_retries"),
   params: z.record(z.any()),
 });
 

package/src/models/components/transactionsreportspec.ts

@@ -8,7 +8,7 @@ export type TransactionsReportSpec = {
   /**
    * The report model type.
    */
-  model?: "transactions" | undefined;
+  model: "transactions";
   /**
    * The parameters for the transactions report model.
    */
@@ -27,7 +27,7 @@ export const TransactionsReportSpec$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TransactionsReportSpec
 > = z.object({
-  model: z.literal("transactions").default("transactions" as const),
+  model: z.literal("transactions"),
   params: z.record(z.any()),
 });