@gr4vy/sdk 2.3.27 → 2.3.29

package/src/models/components/giftcardissuance.ts

@@ -0,0 +1,95 @@
+/*
+ * 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";
+import {
+  GiftCardService,
+  GiftCardService$inboundSchema,
+} from "./giftcardservice.js";
+
+export type GiftCardIssuance = {
+  /**
+   * Always `gift-card-issuance`.
+   */
+  type: "gift-card-issuance";
+  /**
+   * The ID for the gift card issuance.
+   */
+  id: string;
+  /**
+   * The ID of the merchant account this gift card issuance belongs to.
+   */
+  merchantAccountId: string;
+  giftCardService: GiftCardService;
+  /**
+   * The identifier for this issuance as provided by the gift card service.
+   */
+  giftCardServicePaymentIssuanceId: string;
+  /**
+   * The URL for the issued gift card.
+   */
+  url: string;
+  /**
+   * The amount loaded onto the gift card, in the smallest denomination for the currency.
+   */
+  amount: number;
+  /**
+   * The ISO-4217 currency code for the `amount`.
+   */
+  currency: string;
+  /**
+   * The external identifier provided when issuing the gift card.
+   */
+  externalIdentifier?: string | null | undefined;
+  /**
+   * The date and time when this gift card was issued.
+   */
+  createdAt: Date;
+  /**
+   * The date and time when this gift card issuance was last updated.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const GiftCardIssuance$inboundSchema: z.ZodType<
+  GiftCardIssuance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("gift-card-issuance").default("gift-card-issuance"),
+  id: z.string(),
+  merchant_account_id: z.string(),
+  gift_card_service: GiftCardService$inboundSchema,
+  gift_card_service_payment_issuance_id: z.string(),
+  url: z.string(),
+  amount: z.number().int(),
+  currency: z.string(),
+  external_identifier: z.nullable(z.string()).optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "merchant_account_id": "merchantAccountId",
+    "gift_card_service": "giftCardService",
+    "gift_card_service_payment_issuance_id": "giftCardServicePaymentIssuanceId",
+    "external_identifier": "externalIdentifier",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function giftCardIssuanceFromJSON(
+  jsonString: string,
+): SafeParseResult<GiftCardIssuance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GiftCardIssuance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GiftCardIssuance' from JSON`,
+  );
+}

package/src/models/components/giftcardissuancecreate.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * The details used to issue a new virtual gift card.
+ */
+export type GiftCardIssuanceCreate = {
+  /**
+   * The provider theme code to issue the gift card against.
+   */
+  theme: string;
+  /**
+   * The amount to load onto the gift card, in the smallest denomination for the currency.
+   */
+  amount: number;
+  /**
+   * The ISO-4217 currency code for the `amount`.
+   */
+  currency: string;
+  /**
+   * An optional external identifier for this issuance.
+   */
+  externalIdentifier?: string | null | undefined;
+};
+
+/** @internal */
+export type GiftCardIssuanceCreate$Outbound = {
+  theme: string;
+  amount: number;
+  currency: string;
+  external_identifier?: string | null | undefined;
+};
+
+/** @internal */
+export const GiftCardIssuanceCreate$outboundSchema: z.ZodType<
+  GiftCardIssuanceCreate$Outbound,
+  z.ZodTypeDef,
+  GiftCardIssuanceCreate
+> = z.object({
+  theme: z.string(),
+  amount: z.number().int(),
+  currency: z.string(),
+  externalIdentifier: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    externalIdentifier: "external_identifier",
+  });
+});
+
+export function giftCardIssuanceCreateToJSON(
+  giftCardIssuanceCreate: GiftCardIssuanceCreate,
+): string {
+  return JSON.stringify(
+    GiftCardIssuanceCreate$outboundSchema.parse(giftCardIssuanceCreate),
+  );
+}

package/src/models/components/index.ts

@@ -120,9 +120,12 @@ export * from "./forterantifraudoptionscartitemdeliverydetails.js";
 export * from "./forterantifraudoptionsdiscount.js";
 export * from "./forterantifraudoptionsdiscountcoupondiscountamount.js";
 export * from "./giftcard.js";
+export * from "./giftcardactivationcreate.js";
 export * from "./giftcardbalancerequest.js";
 export * from "./giftcardcreate.js";
 export * from "./giftcarderrorcode.js";
+export * from "./giftcardissuance.js";
+export * from "./giftcardissuancecreate.js";
 export * from "./giftcardredemption.js";
 export * from "./giftcardredemptionstatus.js";
 export * from "./giftcardrequest.js";

package/src/models/components/transactionbuyer.ts

@@ -21,6 +21,10 @@ export type TransactionBuyer = {
    * The ID for the buyer.
    */
   id?: string | null | undefined;
+  /**
+   * The base62 encoded buyer ID. This represents a shorter version of this buyer's `id` which is sent to payment services, anti-fraud services, and other connectors. You can use this ID to reconcile a payment service's buyer against our system.
+   */
+  reconciliationId?: string | null | undefined;
   /**
    * The display name for the buyer.
    */
@@ -47,12 +51,14 @@ export const TransactionBuyer$inboundSchema: z.ZodType<
 > = z.object({
   type: z.literal("buyer").default("buyer"),
   id: z.nullable(z.string()).optional(),
+  reconciliation_id: z.nullable(z.string()).optional(),
   display_name: z.nullable(z.string()).optional(),
   external_identifier: z.nullable(z.string()).optional(),
   billing_details: z.nullable(BillingDetails$inboundSchema).optional(),
   account_number: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
+    "reconciliation_id": "reconciliationId",
     "display_name": "displayName",
     "external_identifier": "externalIdentifier",
     "billing_details": "billingDetails",

package/src/models/operations/activategiftcard.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 * as components from "../components/index.js";
+
+export type ActivateGiftCardGlobals = {
+  merchantAccountId?: string | undefined;
+};
+
+export type ActivateGiftCardRequest = {
+  /**
+   * A unique key that identifies this request. If supported by the gift card service, the value will be forwarded to make the activation idempotent. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions.
+   */
+  idempotencyKey?: string | null | undefined;
+  /**
+   * The ID of the merchant account to use for this request.
+   */
+  merchantAccountId?: string | null | undefined;
+  giftCardActivationCreate: components.GiftCardActivationCreate;
+};
+
+/** @internal */
+export type ActivateGiftCardRequest$Outbound = {
+  "idempotency-key"?: string | null | undefined;
+  merchantAccountId?: string | null | undefined;
+  GiftCardActivationCreate: components.GiftCardActivationCreate$Outbound;
+};
+
+/** @internal */
+export const ActivateGiftCardRequest$outboundSchema: z.ZodType<
+  ActivateGiftCardRequest$Outbound,
+  z.ZodTypeDef,
+  ActivateGiftCardRequest
+> = z.object({
+  idempotencyKey: z.nullable(z.string()).optional(),
+  merchantAccountId: z.nullable(z.string()).optional(),
+  giftCardActivationCreate: components.GiftCardActivationCreate$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    giftCardActivationCreate: "GiftCardActivationCreate",
+  });
+});
+
+export function activateGiftCardRequestToJSON(
+  activateGiftCardRequest: ActivateGiftCardRequest,
+): string {
+  return JSON.stringify(
+    ActivateGiftCardRequest$outboundSchema.parse(activateGiftCardRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./activategiftcard.js";
 export * from "./addbuyer.js";
 export * from "./addbuyershippingdetails.js";
 export * from "./addpaymentlink.js";
@@ -66,6 +67,7 @@ export * from "./gettransactioncapture.js";
 export * from "./gettransactionrefund.js";
 export * from "./gettransactionrefundsettlement.js";
 export * from "./gettransactionsettlement.js";
+export * from "./issuegiftcard.js";
 export * from "./listallreportexecutions.js";
 export * from "./listapikeypairs.js";
 export * from "./listauditlogs.js";

package/src/models/operations/issuegiftcard.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 * as components from "../components/index.js";
+
+export type IssueGiftCardGlobals = {
+  merchantAccountId?: string | undefined;
+};
+
+export type IssueGiftCardRequest = {
+  /**
+   * A unique key forwarded to the gift card service to make the issuance idempotent.
+   */
+  idempotencyKey?: string | null | undefined;
+  /**
+   * The ID of the merchant account to use for this request.
+   */
+  merchantAccountId?: string | null | undefined;
+  giftCardIssuanceCreate: components.GiftCardIssuanceCreate;
+};
+
+/** @internal */
+export type IssueGiftCardRequest$Outbound = {
+  "idempotency-key"?: string | null | undefined;
+  merchantAccountId?: string | null | undefined;
+  GiftCardIssuanceCreate: components.GiftCardIssuanceCreate$Outbound;
+};
+
+/** @internal */
+export const IssueGiftCardRequest$outboundSchema: z.ZodType<
+  IssueGiftCardRequest$Outbound,
+  z.ZodTypeDef,
+  IssueGiftCardRequest
+> = z.object({
+  idempotencyKey: z.nullable(z.string()).optional(),
+  merchantAccountId: z.nullable(z.string()).optional(),
+  giftCardIssuanceCreate: components.GiftCardIssuanceCreate$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    giftCardIssuanceCreate: "GiftCardIssuanceCreate",
+  });
+});
+
+export function issueGiftCardRequestToJSON(
+  issueGiftCardRequest: IssueGiftCardRequest,
+): string {
+  return JSON.stringify(
+    IssueGiftCardRequest$outboundSchema.parse(issueGiftCardRequest),
+  );
+}

package/src/sdk/activations.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { giftCardsActivationsCreate } from "../funcs/giftCardsActivationsCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Activations extends ClientSDK {
+  /**
+   * Activate a gift card
+   *
+   * @remarks
+   * Activate a physical gift card through the primary gift card service.
+   */
+  async create(
+    giftCardActivationCreate: components.GiftCardActivationCreate,
+    idempotencyKey?: string | null | undefined,
+    merchantAccountId?: string | null | undefined,
+    options?: RequestOptions,
+  ): Promise<components.GiftCard> {
+    return unwrapAsync(giftCardsActivationsCreate(
+      this,
+      giftCardActivationCreate,
+      idempotencyKey,
+      merchantAccountId,
+      options,
+    ));
+  }
+}

package/src/sdk/giftcards.ts

@@ -11,7 +11,9 @@ import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { Activations } from "./activations.js";
 import { Balances } from "./balances.js";
+import { Issuances } from "./issuances.js";
 
 export class GiftCards extends ClientSDK {
   private _balances?: Balances;
@@ -19,6 +21,16 @@ export class GiftCards extends ClientSDK {
     return (this._balances ??= new Balances(this._options));
   }
 
+  private _activations?: Activations;
+  get activations(): Activations {
+    return (this._activations ??= new Activations(this._options));
+  }
+
+  private _issuances?: Issuances;
+  get issuances(): Issuances {
+    return (this._issuances ??= new Issuances(this._options));
+  }
+
   /**
    * Get gift card
    *

package/src/sdk/issuances.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { giftCardsIssuancesCreate } from "../funcs/giftCardsIssuancesCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Issuances extends ClientSDK {
+  /**
+   * Issue a gift card
+   *
+   * @remarks
+   * Issue a new virtual gift card through the primary gift card service.
+   */
+  async create(
+    giftCardIssuanceCreate: components.GiftCardIssuanceCreate,
+    idempotencyKey?: string | null | undefined,
+    merchantAccountId?: string | null | undefined,
+    options?: RequestOptions,
+  ): Promise<components.GiftCardIssuance> {
+    return unwrapAsync(giftCardsIssuancesCreate(
+      this,
+      giftCardIssuanceCreate,
+      idempotencyKey,
+      merchantAccountId,
+      options,
+    ));
+  }
+}