@paygentic/sdk 0.7.14 → 0.7.15

package/src/models/operations/listexternalreferences.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type ListExternalReferencesRequest = {
+  /**
+   * Restrict results to a specific merchant. All active filters AND together.
+   */
+  merchantId?: string | undefined;
+  /**
+   * Filter by the Paygentic entity type the reference points at (e.g. `item`). All active filters AND together.
+   */
+  entityType?: models.EntityType | undefined;
+  /**
+   * Filter by the Paygentic entity id (e.g. `itm_xxx`). This is the inverse of the `GET /v0/items?provider=&externalId=` resolution endpoint — look up references from the Paygentic side. All active filters AND together.
+   */
+  entityId?: string | undefined;
+  /**
+   * Filter by provider (e.g. `salesforce`, `netsuite`). All active filters AND together.
+   */
+  provider?: string | undefined;
+  /**
+   * Filter by the external system's record id. Pair with `provider` to look up all Paygentic entities that carry a given external reference. All active filters AND together.
+   */
+  externalId?: string | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+};
+
+/**
+ * List of external references
+ */
+export type ListExternalReferencesResponse = {
+  data: Array<models.ExternalReference>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination: models.OffsetPagination;
+};
+
+/** @internal */
+export type ListExternalReferencesRequest$Outbound = {
+  merchantId?: string | undefined;
+  entityType?: string | undefined;
+  entityId?: string | undefined;
+  provider?: string | undefined;
+  externalId?: string | undefined;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const ListExternalReferencesRequest$outboundSchema: z.ZodType<
+  ListExternalReferencesRequest$Outbound,
+  z.ZodTypeDef,
+  ListExternalReferencesRequest
+> = z.object({
+  merchantId: z.string().optional(),
+  entityType: models.EntityType$outboundSchema.optional(),
+  entityId: z.string().optional(),
+  provider: z.string().optional(),
+  externalId: z.string().optional(),
+  limit: z.number().int().default(50),
+  offset: z.number().int().default(0),
+});
+
+export function listExternalReferencesRequestToJSON(
+  listExternalReferencesRequest: ListExternalReferencesRequest,
+): string {
+  return JSON.stringify(
+    ListExternalReferencesRequest$outboundSchema.parse(
+      listExternalReferencesRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListExternalReferencesResponse$inboundSchema: z.ZodType<
+  ListExternalReferencesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(models.ExternalReference$inboundSchema),
+  pagination: models.OffsetPagination$inboundSchema,
+});
+
+export function listExternalReferencesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListExternalReferencesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListExternalReferencesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListExternalReferencesResponse' from JSON`,
+  );
+}

package/src/models/operations/listitems.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type ListItemsRequest = {
+  /**
+   * Filter items by merchant organization id
+   */
+  merchantId?: string | undefined;
+  /**
+   * Provider whose external code to resolve (e.g. `salesforce`, `netsuite`). Must be supplied together with `externalId`.
+   */
+  provider?: string | undefined;
+  /**
+   * Resolve every live Item mapped to this `(provider, externalId)` — the canonical primary plus any non-primary aliases. The primary Item is returned first and is identifiable by its matching reference's `isPrimary: true`. Empty list on no match. Must be supplied together with `provider`.
+   */
+  externalId?: string | undefined;
+  /**
+   * Maximum items to return. In resolution mode (`provider`+`externalId` supplied) pagination is over the de-duplicated resolved Item set, primary Item first.
+   */
+  limit?: number | undefined;
+  /**
+   * Zero-based offset for pagination. In resolution mode this paginates the de-duplicated resolved Item set.
+   */
+  offset?: number | undefined;
+};
+
+/**
+ * List of items
+ */
+export type ListItemsResponse = {
+  data: Array<models.Item>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination: models.OffsetPagination;
+};
+
+/** @internal */
+export type ListItemsRequest$Outbound = {
+  merchantId?: string | undefined;
+  provider?: string | undefined;
+  externalId?: string | undefined;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const ListItemsRequest$outboundSchema: z.ZodType<
+  ListItemsRequest$Outbound,
+  z.ZodTypeDef,
+  ListItemsRequest
+> = z.object({
+  merchantId: z.string().optional(),
+  provider: z.string().optional(),
+  externalId: z.string().optional(),
+  limit: z.number().int().default(50),
+  offset: z.number().int().default(0),
+});
+
+export function listItemsRequestToJSON(
+  listItemsRequest: ListItemsRequest,
+): string {
+  return JSON.stringify(
+    ListItemsRequest$outboundSchema.parse(listItemsRequest),
+  );
+}
+
+/** @internal */
+export const ListItemsResponse$inboundSchema: z.ZodType<
+  ListItemsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(models.Item$inboundSchema),
+  pagination: models.OffsetPagination$inboundSchema,
+});
+
+export function listItemsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListItemsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListItemsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListItemsResponse' from JSON`,
+  );
+}

package/src/models/operations/listmerchantintegrations.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type ListMerchantIntegrationsRequest = {
+  /**
+   * Restrict results to a specific merchant. All active filters AND together.
+   */
+  merchantId?: string | undefined;
+  /**
+   * Filter by provider (e.g. `salesforce`).
+   */
+  provider?: models.MerchantIntegrationProvider | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+};
+
+/**
+ * List of merchant integrations
+ */
+export type ListMerchantIntegrationsResponse = {
+  data: Array<models.MerchantIntegration>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination: models.OffsetPagination;
+};
+
+/** @internal */
+export type ListMerchantIntegrationsRequest$Outbound = {
+  merchantId?: string | undefined;
+  provider?: string | undefined;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const ListMerchantIntegrationsRequest$outboundSchema: z.ZodType<
+  ListMerchantIntegrationsRequest$Outbound,
+  z.ZodTypeDef,
+  ListMerchantIntegrationsRequest
+> = z.object({
+  merchantId: z.string().optional(),
+  provider: models.MerchantIntegrationProvider$outboundSchema.optional(),
+  limit: z.number().int().default(50),
+  offset: z.number().int().default(0),
+});
+
+export function listMerchantIntegrationsRequestToJSON(
+  listMerchantIntegrationsRequest: ListMerchantIntegrationsRequest,
+): string {
+  return JSON.stringify(
+    ListMerchantIntegrationsRequest$outboundSchema.parse(
+      listMerchantIntegrationsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListMerchantIntegrationsResponse$inboundSchema: z.ZodType<
+  ListMerchantIntegrationsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(models.MerchantIntegration$inboundSchema),
+  pagination: models.OffsetPagination$inboundSchema,
+});
+
+export function listMerchantIntegrationsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListMerchantIntegrationsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListMerchantIntegrationsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListMerchantIntegrationsResponse' from JSON`,
+  );
+}

package/src/models/operations/updateexternalreference.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type UpdateExternalReferenceRequestBody = {
+  externalLabel?: string | null | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  isPrimary?: boolean | undefined;
+  isDefault?: boolean | undefined;
+};
+
+export type UpdateExternalReferenceRequest = {
+  /**
+   * The unique identifier of the external reference
+   */
+  id: string;
+  requestBody: UpdateExternalReferenceRequestBody;
+};
+
+/** @internal */
+export type UpdateExternalReferenceRequestBody$Outbound = {
+  externalLabel?: string | null | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  isPrimary?: boolean | undefined;
+  isDefault?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateExternalReferenceRequestBody$outboundSchema: z.ZodType<
+  UpdateExternalReferenceRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateExternalReferenceRequestBody
+> = z.object({
+  externalLabel: z.nullable(z.string()).optional(),
+  metadata: z.record(z.any()).optional(),
+  isPrimary: z.boolean().optional(),
+  isDefault: z.boolean().optional(),
+});
+
+export function updateExternalReferenceRequestBodyToJSON(
+  updateExternalReferenceRequestBody: UpdateExternalReferenceRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateExternalReferenceRequestBody$outboundSchema.parse(
+      updateExternalReferenceRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateExternalReferenceRequest$Outbound = {
+  id: string;
+  RequestBody: UpdateExternalReferenceRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateExternalReferenceRequest$outboundSchema: z.ZodType<
+  UpdateExternalReferenceRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateExternalReferenceRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => UpdateExternalReferenceRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateExternalReferenceRequestToJSON(
+  updateExternalReferenceRequest: UpdateExternalReferenceRequest,
+): string {
+  return JSON.stringify(
+    UpdateExternalReferenceRequest$outboundSchema.parse(
+      updateExternalReferenceRequest,
+    ),
+  );
+}

package/src/models/operations/updateitem.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type UpdateItemRequestBody = {
+  name?: string | undefined;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+export type UpdateItemRequest = {
+  /**
+   * The unique identifier of the item
+   */
+  id: string;
+  requestBody: UpdateItemRequestBody;
+};
+
+/** @internal */
+export type UpdateItemRequestBody$Outbound = {
+  name?: string | undefined;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const UpdateItemRequestBody$outboundSchema: z.ZodType<
+  UpdateItemRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateItemRequestBody
+> = z.object({
+  name: z.string().optional(),
+  metadata: z.record(z.any()).optional(),
+});
+
+export function updateItemRequestBodyToJSON(
+  updateItemRequestBody: UpdateItemRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateItemRequestBody$outboundSchema.parse(updateItemRequestBody),
+  );
+}
+
+/** @internal */
+export type UpdateItemRequest$Outbound = {
+  id: string;
+  RequestBody: UpdateItemRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateItemRequest$outboundSchema: z.ZodType<
+  UpdateItemRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateItemRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => UpdateItemRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateItemRequestToJSON(
+  updateItemRequest: UpdateItemRequest,
+): string {
+  return JSON.stringify(
+    UpdateItemRequest$outboundSchema.parse(updateItemRequest),
+  );
+}

package/src/models/operations/upsertmerchantintegration.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type UpsertMerchantIntegrationRequest = {
+  /**
+   * Unique identifier for an organization
+   */
+  merchantId: string;
+  /**
+   * External provider a merchant can connect at the tenant level
+   */
+  provider: models.MerchantIntegrationProvider;
+  /**
+   * Ampersand installation id.
+   */
+  externalId?: string | undefined;
+  /**
+   * Connection lifecycle state. Live Ampersand health is separate and not stored here.
+   */
+  status?: models.MerchantIntegrationStatus | undefined;
+  config?: { [k: string]: any } | undefined;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export type UpsertMerchantIntegrationRequest$Outbound = {
+  merchantId: string;
+  provider: string;
+  externalId?: string | undefined;
+  status?: string | undefined;
+  config?: { [k: string]: any } | undefined;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const UpsertMerchantIntegrationRequest$outboundSchema: z.ZodType<
+  UpsertMerchantIntegrationRequest$Outbound,
+  z.ZodTypeDef,
+  UpsertMerchantIntegrationRequest
+> = z.object({
+  merchantId: z.string(),
+  provider: models.MerchantIntegrationProvider$outboundSchema,
+  externalId: z.string().optional(),
+  status: models.MerchantIntegrationStatus$outboundSchema.optional(),
+  config: z.record(z.any()).optional(),
+  metadata: z.record(z.any()).optional(),
+});
+
+export function upsertMerchantIntegrationRequestToJSON(
+  upsertMerchantIntegrationRequest: UpsertMerchantIntegrationRequest,
+): string {
+  return JSON.stringify(
+    UpsertMerchantIntegrationRequest$outboundSchema.parse(
+      upsertMerchantIntegrationRequest,
+    ),
+  );
+}

package/src/models/price.ts

@@ -35,6 +35,10 @@ export type Price = {
    */
   id: string;
   object: PriceObject;
+  /**
+   * Unique identifier for an organization
+   */
+  merchantId: string;
   billableMetricId?: string | undefined;
   /**
    * The unique identifier for the fee referred to by this price
@@ -85,6 +89,7 @@ export const Price$inboundSchema: z.ZodType<Price, z.ZodTypeDef, unknown> = z
   .object({
     id: z.string(),
     object: PriceObject$inboundSchema.default("price"),
+    merchantId: z.string(),
     billableMetricId: z.string().optional(),
     feeId: z.string().optional(),
     billingCadence: z.nullable(z.string()).optional(),

package/src/models/schemasprice.ts

@@ -49,6 +49,10 @@ export type SchemasPrice = {
    * The unique identifier for the fee referred to by this price. Present when price is linked to a fee.
    */
   feeId?: string | undefined;
+  /**
+   * Unique identifier for an organization
+   */
+  merchantId: string;
   /**
    * ISO 8601 duration. 'P0D' for one-time, 'P1M' for monthly, 'P1Y' for yearly. Required for fees, optional for billable metrics. Defaults to plan's billingCadence if not specified.
    */
@@ -98,6 +102,7 @@ export const SchemasPrice$inboundSchema: z.ZodType<
   object: SchemasPriceObject$inboundSchema.default("price"),
   billableMetricId: z.string().optional(),
   feeId: z.string().optional(),
+  merchantId: z.string(),
   billingCadence: z.nullable(z.string()).optional(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   invoiceDisplayName: z.string(),

package/src/models/subscription.ts

@@ -140,6 +140,10 @@ export type SubscriptionCustomer = {
 export type Subscription = {
   id: string;
   object: SubscriptionObject;
+  /**
+   * Unique identifier for an organization
+   */
+  merchantId: string;
   /**
    * Whether automatic charging is enabled for this subscription. When true, invoices will be automatically paid using stored payment methods.
    */
@@ -404,6 +408,7 @@ export const Subscription$inboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   object: SubscriptionObject$inboundSchema,
+  merchantId: z.string(),
   autoCharge: z.boolean().default(false),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   customerId: z.string(),

package/src/sdk/externalreferences.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { externalReferencesCreateExternalReference } from "../funcs/externalReferencesCreateExternalReference.js";
+import { externalReferencesDeleteExternalReference } from "../funcs/externalReferencesDeleteExternalReference.js";
+import { externalReferencesGetExternalReference } from "../funcs/externalReferencesGetExternalReference.js";
+import { externalReferencesListExternalReferences } from "../funcs/externalReferencesListExternalReferences.js";
+import { externalReferencesUpdateExternalReference } from "../funcs/externalReferencesUpdateExternalReference.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class ExternalReferences extends ClientSDK {
+  /**
+   * Create
+   */
+  async createExternalReference(
+    request: operations.CreateExternalReferenceRequest,
+    options?: RequestOptions,
+  ): Promise<models.ExternalReference> {
+    return unwrapAsync(externalReferencesCreateExternalReference(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List
+   */
+  async listExternalReferences(
+    request?: operations.ListExternalReferencesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListExternalReferencesResponse> {
+    return unwrapAsync(externalReferencesListExternalReferences(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get
+   */
+  async getExternalReference(
+    request: operations.GetExternalReferenceRequest,
+    options?: RequestOptions,
+  ): Promise<models.ExternalReference> {
+    return unwrapAsync(externalReferencesGetExternalReference(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update
+   */
+  async updateExternalReference(
+    request: operations.UpdateExternalReferenceRequest,
+    options?: RequestOptions,
+  ): Promise<models.ExternalReference> {
+    return unwrapAsync(externalReferencesUpdateExternalReference(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete
+   */
+  async deleteExternalReference(
+    request: operations.DeleteExternalReferenceRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(externalReferencesDeleteExternalReference(
+      this,
+      request,
+      options,
+    ));
+  }
+}