@paygentic/sdk 0.7.14 → 0.7.16

package/src/models/item.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  ExternalReference,
+  ExternalReference$inboundSchema,
+} from "./externalreference.js";
+
+export const ItemObject = {
+  Item: "item",
+} as const;
+export type ItemObject = ClosedEnum<typeof ItemObject>;
+
+export type Item = {
+  id: string;
+  object: ItemObject;
+  merchantId: string;
+  name: string;
+  metadata: { [k: string]: any };
+  externalReferences: Array<ExternalReference>;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const ItemObject$inboundSchema: z.ZodNativeEnum<typeof ItemObject> = z
+  .nativeEnum(ItemObject);
+
+/** @internal */
+export const Item$inboundSchema: z.ZodType<Item, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    object: ItemObject$inboundSchema.default("item"),
+    merchantId: z.string(),
+    name: z.string(),
+    metadata: z.record(z.any()),
+    externalReferences: z.array(ExternalReference$inboundSchema),
+    createdAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    updatedAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+  });
+
+export function itemFromJSON(
+  jsonString: string,
+): SafeParseResult<Item, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Item$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Item' from JSON`,
+  );
+}

package/src/models/lineitem.ts

@@ -55,6 +55,10 @@ export type LineItem = {
    * The subscription this line item belongs to
    */
   subscriptionId: string;
+  /**
+   * The customer ID that owns this line item
+   */
+  customerId: string;
   /**
    * The price ID associated with this line item
    */
@@ -167,6 +171,7 @@ export const LineItem$inboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   subscriptionId: z.string(),
+  customerId: z.string(),
   priceId: z.nullable(z.string()).optional(),
   invoiceId: z.nullable(z.string()).optional(),
   type: LineItemType$inboundSchema,

package/src/models/merchantintegration.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  MerchantIntegrationProvider,
+  MerchantIntegrationProvider$inboundSchema,
+} from "./merchantintegrationprovider.js";
+import {
+  MerchantIntegrationStatus,
+  MerchantIntegrationStatus$inboundSchema,
+} from "./merchantintegrationstatus.js";
+
+export const MerchantIntegrationObject = {
+  MerchantIntegration: "merchantIntegration",
+} as const;
+export type MerchantIntegrationObject = ClosedEnum<
+  typeof MerchantIntegrationObject
+>;
+
+/**
+ * A merchant's tenant-level connection to an external provider via Ampersand.
+ */
+export type MerchantIntegration = {
+  /**
+   * Unique identifier for a merchant integration
+   */
+  id: string;
+  object: MerchantIntegrationObject;
+  /**
+   * Unique identifier for an organization
+   */
+  merchantId: string;
+  /**
+   * External provider a merchant can connect at the tenant level
+   */
+  provider: MerchantIntegrationProvider;
+  /**
+   * Ampersand installation id.
+   */
+  externalId: string | null;
+  /**
+   * Connection lifecycle state. Live Ampersand health is separate and not stored here.
+   */
+  status: MerchantIntegrationStatus;
+  config: { [k: string]: any };
+  metadata: { [k: string]: any };
+  connectedAt: Date;
+  disconnectedAt: Date | null;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const MerchantIntegrationObject$inboundSchema: z.ZodNativeEnum<
+  typeof MerchantIntegrationObject
+> = z.nativeEnum(MerchantIntegrationObject);
+
+/** @internal */
+export const MerchantIntegration$inboundSchema: z.ZodType<
+  MerchantIntegration,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  object: MerchantIntegrationObject$inboundSchema.default(
+    "merchantIntegration",
+  ),
+  merchantId: z.string(),
+  provider: MerchantIntegrationProvider$inboundSchema,
+  externalId: z.nullable(z.string()),
+  status: MerchantIntegrationStatus$inboundSchema,
+  config: z.record(z.any()),
+  metadata: z.record(z.any()),
+  connectedAt: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  disconnectedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function merchantIntegrationFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantIntegration, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantIntegration$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantIntegration' from JSON`,
+  );
+}

package/src/models/merchantintegrationprovider.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * External provider a merchant can connect at the tenant level
+ */
+export const MerchantIntegrationProvider = {
+  Salesforce: "salesforce",
+} as const;
+/**
+ * External provider a merchant can connect at the tenant level
+ */
+export type MerchantIntegrationProvider = ClosedEnum<
+  typeof MerchantIntegrationProvider
+>;
+
+/** @internal */
+export const MerchantIntegrationProvider$inboundSchema: z.ZodNativeEnum<
+  typeof MerchantIntegrationProvider
+> = z.nativeEnum(MerchantIntegrationProvider);
+/** @internal */
+export const MerchantIntegrationProvider$outboundSchema: z.ZodNativeEnum<
+  typeof MerchantIntegrationProvider
+> = MerchantIntegrationProvider$inboundSchema;

package/src/models/merchantintegrationstatus.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Connection lifecycle state. Live Ampersand health is separate and not stored here.
+ */
+export const MerchantIntegrationStatus = {
+  Active: "active",
+  Disconnected: "disconnected",
+  Error: "error",
+} as const;
+/**
+ * Connection lifecycle state. Live Ampersand health is separate and not stored here.
+ */
+export type MerchantIntegrationStatus = ClosedEnum<
+  typeof MerchantIntegrationStatus
+>;
+
+/** @internal */
+export const MerchantIntegrationStatus$inboundSchema: z.ZodNativeEnum<
+  typeof MerchantIntegrationStatus
+> = z.nativeEnum(MerchantIntegrationStatus);
+/** @internal */
+export const MerchantIntegrationStatus$outboundSchema: z.ZodNativeEnum<
+  typeof MerchantIntegrationStatus
+> = MerchantIntegrationStatus$inboundSchema;

package/src/models/operations/createexternalreference.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type CreateExternalReferenceRequest = {
+  merchantId: string;
+  /**
+   * The type of Paygentic entity this external reference points at
+   */
+  entityType: models.EntityType;
+  /**
+   * Paygentic id of the entity, e.g. `itm_xxx`
+   */
+  entityId: string;
+  /**
+   * Lowercase snake_case provider identifier (e.g. `salesforce`, `netsuite`)
+   */
+  provider: string;
+  /**
+   * Identifier of the record in the external system
+   */
+  externalId: string;
+  /**
+   * Human-friendly name shown in UIs (e.g. a NetSuite financial-treatment name)
+   */
+  externalLabel?: string | undefined;
+  /**
+   * Provider-specific fields (e.g. `{ "sfObject": "Product2" }`)
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * Whether this is the canonical reference for `(provider, externalId)`. The primary is unique per merchant; non-primary references are aliases.
+   */
+  isPrimary?: boolean | undefined;
+  /**
+   * Whether this is the default target for the entity + provider. At most one default per `(entityType, entityId, provider)`.
+   */
+  isDefault?: boolean | undefined;
+};
+
+/** @internal */
+export type CreateExternalReferenceRequest$Outbound = {
+  merchantId: string;
+  entityType: string;
+  entityId: string;
+  provider: string;
+  externalId: string;
+  externalLabel?: string | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  isPrimary: boolean;
+  isDefault: boolean;
+};
+
+/** @internal */
+export const CreateExternalReferenceRequest$outboundSchema: z.ZodType<
+  CreateExternalReferenceRequest$Outbound,
+  z.ZodTypeDef,
+  CreateExternalReferenceRequest
+> = z.object({
+  merchantId: z.string(),
+  entityType: models.EntityType$outboundSchema,
+  entityId: z.string(),
+  provider: z.string(),
+  externalId: z.string(),
+  externalLabel: z.string().optional(),
+  metadata: z.record(z.any()).optional(),
+  isPrimary: z.boolean().default(true),
+  isDefault: z.boolean().default(false),
+});
+
+export function createExternalReferenceRequestToJSON(
+  createExternalReferenceRequest: CreateExternalReferenceRequest,
+): string {
+  return JSON.stringify(
+    CreateExternalReferenceRequest$outboundSchema.parse(
+      createExternalReferenceRequest,
+    ),
+  );
+}

package/src/models/operations/createitem.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type CreateItemRequest = {
+  merchantId: string;
+  /**
+   * Canonical sellable name for the Item
+   */
+  name: string;
+  /**
+   * Optional key-value metadata
+   */
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export type CreateItemRequest$Outbound = {
+  merchantId: string;
+  name: string;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateItemRequest$outboundSchema: z.ZodType<
+  CreateItemRequest$Outbound,
+  z.ZodTypeDef,
+  CreateItemRequest
+> = z.object({
+  merchantId: z.string(),
+  name: z.string(),
+  metadata: z.record(z.any()).optional(),
+});
+
+export function createItemRequestToJSON(
+  createItemRequest: CreateItemRequest,
+): string {
+  return JSON.stringify(
+    CreateItemRequest$outboundSchema.parse(createItemRequest),
+  );
+}

package/src/models/operations/deleteexternalreference.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeleteExternalReferenceRequest = {
+  /**
+   * The unique identifier of the external reference
+   */
+  id: string;
+};
+
+/** @internal */
+export type DeleteExternalReferenceRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DeleteExternalReferenceRequest$outboundSchema: z.ZodType<
+  DeleteExternalReferenceRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteExternalReferenceRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function deleteExternalReferenceRequestToJSON(
+  deleteExternalReferenceRequest: DeleteExternalReferenceRequest,
+): string {
+  return JSON.stringify(
+    DeleteExternalReferenceRequest$outboundSchema.parse(
+      deleteExternalReferenceRequest,
+    ),
+  );
+}

package/src/models/operations/deleteitem.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeleteItemRequest = {
+  /**
+   * The unique identifier of the item
+   */
+  id: string;
+};
+
+/** @internal */
+export type DeleteItemRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DeleteItemRequest$outboundSchema: z.ZodType<
+  DeleteItemRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteItemRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function deleteItemRequestToJSON(
+  deleteItemRequest: DeleteItemRequest,
+): string {
+  return JSON.stringify(
+    DeleteItemRequest$outboundSchema.parse(deleteItemRequest),
+  );
+}

package/src/models/operations/disconnectmerchantintegration.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DisconnectMerchantIntegrationRequest = {
+  /**
+   * The unique identifier of the merchant integration
+   */
+  id: string;
+};
+
+/** @internal */
+export type DisconnectMerchantIntegrationRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DisconnectMerchantIntegrationRequest$outboundSchema: z.ZodType<
+  DisconnectMerchantIntegrationRequest$Outbound,
+  z.ZodTypeDef,
+  DisconnectMerchantIntegrationRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function disconnectMerchantIntegrationRequestToJSON(
+  disconnectMerchantIntegrationRequest: DisconnectMerchantIntegrationRequest,
+): string {
+  return JSON.stringify(
+    DisconnectMerchantIntegrationRequest$outboundSchema.parse(
+      disconnectMerchantIntegrationRequest,
+    ),
+  );
+}

package/src/models/operations/getexternalreference.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetExternalReferenceRequest = {
+  /**
+   * The unique identifier of the external reference
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetExternalReferenceRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetExternalReferenceRequest$outboundSchema: z.ZodType<
+  GetExternalReferenceRequest$Outbound,
+  z.ZodTypeDef,
+  GetExternalReferenceRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getExternalReferenceRequestToJSON(
+  getExternalReferenceRequest: GetExternalReferenceRequest,
+): string {
+  return JSON.stringify(
+    GetExternalReferenceRequest$outboundSchema.parse(
+      getExternalReferenceRequest,
+    ),
+  );
+}

package/src/models/operations/getitem.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetItemRequest = {
+  /**
+   * The unique identifier of the item
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetItemRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetItemRequest$outboundSchema: z.ZodType<
+  GetItemRequest$Outbound,
+  z.ZodTypeDef,
+  GetItemRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getItemRequestToJSON(getItemRequest: GetItemRequest): string {
+  return JSON.stringify(GetItemRequest$outboundSchema.parse(getItemRequest));
+}

package/src/models/operations/getmerchantintegration.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetMerchantIntegrationRequest = {
+  /**
+   * The unique identifier of the merchant integration
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetMerchantIntegrationRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetMerchantIntegrationRequest$outboundSchema: z.ZodType<
+  GetMerchantIntegrationRequest$Outbound,
+  z.ZodTypeDef,
+  GetMerchantIntegrationRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getMerchantIntegrationRequestToJSON(
+  getMerchantIntegrationRequest: GetMerchantIntegrationRequest,
+): string {
+  return JSON.stringify(
+    GetMerchantIntegrationRequest$outboundSchema.parse(
+      getMerchantIntegrationRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -11,8 +11,10 @@ export * from "./createcost.js";
 export * from "./createcustomer.js";
 export * from "./createcustomerpaymentmethod.js";
 export * from "./createentitlementgrant.js";
+export * from "./createexternalreference.js";
 export * from "./createfeature.js";
 export * from "./createfee.js";
+export * from "./createitem.js";
 export * from "./createlineitem.js";
 export * from "./createpayment.js";
 export * from "./createplan.js";
@@ -23,11 +25,14 @@ export * from "./createsubscription.js";
 export * from "./createtestclock.js";
 export * from "./deletecost.js";
 export * from "./deletecustomer.js";
+export * from "./deleteexternalreference.js";
 export * from "./deletefeature.js";
 export * from "./deletefee.js";
+export * from "./deleteitem.js";
 export * from "./deleteprice.js";
 export * from "./deletesourcerule.js";
 export * from "./deletetestclock.js";
+export * from "./disconnectmerchantintegration.js";
 export * from "./generateportallink.js";
 export * from "./getbillablemetric.js";
 export * from "./getbillablemetricmeter.js";
@@ -37,11 +42,14 @@ export * from "./getcostsummary.js";
 export * from "./getcustomer.js";
 export * from "./getentitlement.js";
 export * from "./getentitlementgrant.js";
+export * from "./getexternalreference.js";
 export * from "./getfeature.js";
 export * from "./getfee.js";
 export * from "./getfeeprice.js";
 export * from "./getinvoice.js";
 export * from "./getinvoicelineitems.js";
+export * from "./getitem.js";
+export * from "./getmerchantintegration.js";
 export * from "./getpayment.js";
 export * from "./getplan.js";
 export * from "./getprice.js";
@@ -62,15 +70,19 @@ export * from "./listcustomerpaymentmethods.js";
 export * from "./listcustomers.js";
 export * from "./listentitlementgrants.js";
 export * from "./listentitlements.js";
+export * from "./listexternalreferences.js";
 export * from "./listfeatures.js";
 export * from "./listfees.js";
 export * from "./listinvoices.js";
+export * from "./listitems.js";
 export * from "./listlineitems.js";
+export * from "./listmerchantintegrations.js";
 export * from "./listpayments.js";
 export * from "./listpaymentsessions.js";
 export * from "./listplans.js";
 export * from "./listprices.js";
 export * from "./listproducts.js";
+export * from "./listsalesforceaccounts.js";
 export * from "./listsourceevents.js";
 export * from "./listsourcerules.js";
 export * from "./listsources.js";
@@ -82,8 +94,10 @@ export * from "./terminatesubscription.js";
 export * from "./updatebillablemetric.js";
 export * from "./updatecost.js";
 export * from "./updatecustomer.js";
+export * from "./updateexternalreference.js";
 export * from "./updatefeature.js";
 export * from "./updatefee.js";
+export * from "./updateitem.js";
 export * from "./updateplan.js";
 export * from "./updateprice.js";
 export * from "./updateproduct.js";
@@ -91,4 +105,5 @@ export * from "./updatesource.js";
 export * from "./updatesourcerule.js";
 export * from "./updatesubscription.js";
 export * from "./updateuser.js";
+export * from "./upsertmerchantintegration.js";
 export * from "./voidentitlementgrant.js";