@paygentic/sdk 0.10.2 → 0.10.4

package/src/models/permission.ts

@@ -0,0 +1,119 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * A permission of the catalog: a resource read or write, or a sensitive action.
+ */
+export const Permission = {
+  OrganizationRead: "organization:read",
+  MembersRead: "members:read",
+  ProfileRead: "profile:read",
+  ApiKeysRead: "apiKeys:read",
+  MerchantsRead: "merchants:read",
+  ConsumersRead: "consumers:read",
+  CustomersRead: "customers:read",
+  PlansRead: "plans:read",
+  PricesRead: "prices:read",
+  ProductsRead: "products:read",
+  FeaturesRead: "features:read",
+  FeesRead: "fees:read",
+  BillableMetricsRead: "billableMetrics:read",
+  ItemsRead: "items:read",
+  PricingUnitsRead: "pricingUnits:read",
+  SubscriptionsRead: "subscriptions:read",
+  SubscriptionAdjustmentsRead: "subscriptionAdjustments:read",
+  DiscountsRead: "discounts:read",
+  GrantsRead: "grants:read",
+  EntitlementsRead: "entitlements:read",
+  CreditPoolsRead: "creditPools:read",
+  OrdersRead: "orders:read",
+  BillingSchedulesRead: "billingSchedules:read",
+  InvoicesRead: "invoices:read",
+  PaymentsRead: "payments:read",
+  PaymentSessionsRead: "paymentSessions:read",
+  PortalSessionsRead: "portalSessions:read",
+  PlatformUsersRead: "platformUsers:read",
+  PlatformAdminRead: "platformAdmin:read",
+  OrganizationCreationRead: "organizationCreation:read",
+  ComplianceRead: "compliance:read",
+  TaxSettingsRead: "taxSettings:read",
+  CostsRead: "costs:read",
+  PaymentAccountsRead: "paymentAccounts:read",
+  PayoutsRead: "payouts:read",
+  ExternalAccountsRead: "externalAccounts:read",
+  ExternalReferencesRead: "externalReferences:read",
+  MerchantIntegrationsRead: "merchantIntegrations:read",
+  WebhooksRead: "webhooks:read",
+  TestClocksRead: "testClocks:read",
+  ApprovalsRead: "approvals:read",
+  SourcesRead: "sources:read",
+  RevenueRead: "revenue:read",
+  OrganizationWrite: "organization:write",
+  MembersWrite: "members:write",
+  ProfileWrite: "profile:write",
+  ApiKeysWrite: "apiKeys:write",
+  MerchantsWrite: "merchants:write",
+  ConsumersWrite: "consumers:write",
+  CustomersWrite: "customers:write",
+  PlansWrite: "plans:write",
+  PricesWrite: "prices:write",
+  ProductsWrite: "products:write",
+  FeaturesWrite: "features:write",
+  FeesWrite: "fees:write",
+  BillableMetricsWrite: "billableMetrics:write",
+  ItemsWrite: "items:write",
+  PricingUnitsWrite: "pricingUnits:write",
+  SubscriptionsWrite: "subscriptions:write",
+  SubscriptionAdjustmentsWrite: "subscriptionAdjustments:write",
+  DiscountsWrite: "discounts:write",
+  GrantsWrite: "grants:write",
+  EntitlementsWrite: "entitlements:write",
+  CreditPoolsWrite: "creditPools:write",
+  OrdersWrite: "orders:write",
+  BillingSchedulesWrite: "billingSchedules:write",
+  InvoicesWrite: "invoices:write",
+  PaymentsWrite: "payments:write",
+  PaymentSessionsWrite: "paymentSessions:write",
+  PortalSessionsWrite: "portalSessions:write",
+  PlatformUsersWrite: "platformUsers:write",
+  PlatformAdminWrite: "platformAdmin:write",
+  OrganizationCreationWrite: "organizationCreation:write",
+  ComplianceWrite: "compliance:write",
+  TaxSettingsWrite: "taxSettings:write",
+  CostsWrite: "costs:write",
+  PaymentAccountsWrite: "paymentAccounts:write",
+  PayoutsWrite: "payouts:write",
+  ExternalAccountsWrite: "externalAccounts:write",
+  ExternalReferencesWrite: "externalReferences:write",
+  MerchantIntegrationsWrite: "merchantIntegrations:write",
+  WebhooksWrite: "webhooks:write",
+  TestClocksWrite: "testClocks:write",
+  ApprovalsWrite: "approvals:write",
+  SourcesWrite: "sources:write",
+  EventsWrite: "events:write",
+  InvoicesIssue: "invoices:issue",
+  InvoicesVoid: "invoices:void",
+  PaymentsRefund: "payments:refund",
+  OrganizationDelete: "organization:delete",
+  OwnershipTransfer: "ownership:transfer",
+  SubscriptionsTerminate: "subscriptions:terminate",
+  SubscriptionsTerminateWithReason: "subscriptions:terminateWithReason",
+  SubscriptionsReconcile: "subscriptions:reconcile",
+  SubscriptionsUpdate: "subscriptions:update",
+  SubscriptionsDelete: "subscriptions:delete",
+  SubscriptionsTaxExempt: "subscriptions:taxExempt",
+  SubscriptionsAutoApprove: "subscriptions:autoApprove",
+  OrganizationResetData: "organization:resetData",
+} as const;
+/**
+ * A permission of the catalog: a resource read or write, or a sensitive action.
+ */
+export type Permission = ClosedEnum<typeof Permission>;
+
+/** @internal */
+export const Permission$inboundSchema: z.ZodNativeEnum<typeof Permission> = z
+  .nativeEnum(Permission);

package/src/models/profitabilitysummaryresponse.ts

@@ -12,7 +12,7 @@ import {
 } from "./profitabilityrow.js";
 
 /**
- * Where the caller's revenue actually lies in time. Scoped by the same filters as the request (merchant, and where given customer, subscription and currency), so it is not an account-wide statement. Present only when the selected range returned nothing. An object carries the bounds of the real revenue; null means no revenue under these filters at any time; an absent field means the extent was not resolved, because the result was not empty or because the lookup failed. An absent field must never be read as an absence. The bounds may span more than this endpoint's maximum queryable range, so clamp before re-querying.
+ * Where the caller's revenue actually lies in time. Scoped by the same filters as the request (merchant, and where given customer, subscription and currency), so it is not an account-wide statement. Present only when the selected range returned nothing. An object carries the bounds of the real revenue; null means no revenue under these filters at any time; an absent field means the extent was not resolved, because the result was not empty or because the lookup failed. An absent field must never be read as an absence. The bounds are instants that exist and both are included, so a window that holds `to` ends after it. The bounds may span more than this endpoint's maximum queryable range, so clamp before re-querying.
  */
 export type ProfitabilitySummaryResponseRevenueRange = {
   /**
@@ -26,7 +26,7 @@ export type ProfitabilitySummaryResponseRevenueRange = {
 };
 
 /**
- * Where the caller's cost data actually lies in time. Present only when the selected range returned no cost. An object carries the bounds of the real cost events; null means the caller has no cost event at any time; an absent field means the extent was not resolved, because the result was not empty, because the lookup failed, or because the metering service does not serve the bounds method. An absent field must never be read as an absence.
+ * Where the caller's cost data actually lies in time. Present only when the selected range returned no cost. An object carries the bounds of the real cost events; null means the caller has no cost event at any time; an absent field means the extent was not resolved, because the result was not empty, because the lookup failed, or because the metering service does not serve the bounds method. An absent field must never be read as an absence. The bounds are instants that exist and both are included, so a window that holds `to` ends after it.
  */
 export type ProfitabilitySummaryResponseCostRange = {
   /**
@@ -73,11 +73,11 @@ export type ProfitabilitySummaryResponse = {
    */
   warnings?: Array<string> | undefined;
   /**
-   * Where the caller's revenue actually lies in time. Scoped by the same filters as the request (merchant, and where given customer, subscription and currency), so it is not an account-wide statement. Present only when the selected range returned nothing. An object carries the bounds of the real revenue; null means no revenue under these filters at any time; an absent field means the extent was not resolved, because the result was not empty or because the lookup failed. An absent field must never be read as an absence. The bounds may span more than this endpoint's maximum queryable range, so clamp before re-querying.
+   * Where the caller's revenue actually lies in time. Scoped by the same filters as the request (merchant, and where given customer, subscription and currency), so it is not an account-wide statement. Present only when the selected range returned nothing. An object carries the bounds of the real revenue; null means no revenue under these filters at any time; an absent field means the extent was not resolved, because the result was not empty or because the lookup failed. An absent field must never be read as an absence. The bounds are instants that exist and both are included, so a window that holds `to` ends after it. The bounds may span more than this endpoint's maximum queryable range, so clamp before re-querying.
    */
   revenueRange?: ProfitabilitySummaryResponseRevenueRange | null | undefined;
   /**
-   * Where the caller's cost data actually lies in time. Present only when the selected range returned no cost. An object carries the bounds of the real cost events; null means the caller has no cost event at any time; an absent field means the extent was not resolved, because the result was not empty, because the lookup failed, or because the metering service does not serve the bounds method. An absent field must never be read as an absence.
+   * Where the caller's cost data actually lies in time. Present only when the selected range returned no cost. An object carries the bounds of the real cost events; null means the caller has no cost event at any time; an absent field means the extent was not resolved, because the result was not empty, because the lookup failed, or because the metering service does not serve the bounds method. An absent field must never be read as an absence. The bounds are instants that exist and both are included, so a window that holds `to` ends after it.
    */
   costRange?: ProfitabilitySummaryResponseCostRange | null | undefined;
 };

package/src/models/revenueaccountrow.ts

@@ -25,7 +25,7 @@ export type RevenueAccountRow = {
    */
   currency: string;
   /**
-   * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount.
+   * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount. `overdue` is a part of `awaitingPayment`.
    */
   outstanding: OutstandingBlock;
 };

package/src/models/revenueaccounttotal.ts

@@ -17,7 +17,7 @@ export type RevenueAccountTotal = {
    */
   currency: string;
   /**
-   * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount.
+   * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount. `overdue` is a part of `awaitingPayment`.
    */
   outstanding: OutstandingBlock;
 };

package/src/models/revenuesummaryresponse.ts

@@ -28,7 +28,7 @@ import {
 } from "./revenuetrendbucket.js";
 
 /**
- * Where the caller's revenue actually lies in time. Scoped by the same filters as the request (merchant, and where given customer, subscription and currency), so it is not an account-wide statement. Present only when the selected range returned nothing. An object carries the bounds of the real revenue; null means no revenue under these filters at any time; an absent field means the extent was not resolved, because the result was not empty or because the lookup failed. An absent field must never be read as an absence. The bounds may span more than this endpoint's maximum queryable range, so clamp before re-querying.
+ * Where the caller's revenue actually lies in time. Scoped by the same filters as the request (merchant, and where given customer, subscription and currency), so it is not an account-wide statement. Present only when the selected range returned nothing. An object carries the bounds of the real revenue; null means no revenue under these filters at any time; an absent field means the extent was not resolved, because the result was not empty or because the lookup failed. An absent field must never be read as an absence. The bounds are instants that exist and both are included, so a window that holds `to` ends after it. The bounds may span more than this endpoint's maximum queryable range, so clamp before re-querying.
  */
 export type RevenueSummaryResponseRevenueRange = {
   /**
@@ -85,7 +85,7 @@ export type RevenueSummaryResponse = {
    */
   currencyBreakdown?: Array<CurrencyBreakdownEntry> | undefined;
   /**
-   * Where the caller's revenue actually lies in time. Scoped by the same filters as the request (merchant, and where given customer, subscription and currency), so it is not an account-wide statement. Present only when the selected range returned nothing. An object carries the bounds of the real revenue; null means no revenue under these filters at any time; an absent field means the extent was not resolved, because the result was not empty or because the lookup failed. An absent field must never be read as an absence. The bounds may span more than this endpoint's maximum queryable range, so clamp before re-querying.
+   * Where the caller's revenue actually lies in time. Scoped by the same filters as the request (merchant, and where given customer, subscription and currency), so it is not an account-wide statement. Present only when the selected range returned nothing. An object carries the bounds of the real revenue; null means no revenue under these filters at any time; an absent field means the extent was not resolved, because the result was not empty or because the lookup failed. An absent field must never be read as an absence. The bounds are instants that exist and both are included, so a window that holds `to` ends after it. The bounds may span more than this endpoint's maximum queryable range, so clamp before re-querying.
    */
   revenueRange?: RevenueSummaryResponseRevenueRange | null | undefined;
 };

package/src/sdk/me.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { meGetMe } from "../funcs/meGetMe.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Me extends ClientSDK {
+  /**
+   * Get the caller
+   *
+   * @remarks
+   * Returns the caller's identity in its active organization, its roles, and the permissions that its credential holds there. The permissions are the effective set for the credential of the call: for a session or an API key, those of the principal; for an OAuth token, those of the principal narrowed to the scopes of the token.
+   */
+  async getMe(
+    options?: RequestOptions,
+  ): Promise<models.Me> {
+    return unwrapAsync(meGetMe(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -15,6 +15,7 @@ import { Features } from "./features.js";
 import { Fees } from "./fees.js";
 import { InvoicesV2 } from "./invoicesv2.js";
 import { Items } from "./items.js";
+import { Me } from "./me.js";
 import { MerchantIntegrations } from "./merchantintegrations.js";
 import { Merchants } from "./merchants.js";
 import { Orders } from "./orders.js";
@@ -33,6 +34,11 @@ import { Users } from "./users.js";
 import { Webhooks } from "./webhooks.js";
 
 export class Paygentic extends ClientSDK {
+  private _me?: Me;
+  get me(): Me {
+    return (this._me ??= new Me(this._options));
+  }
+
   private _billableMetrics?: BillableMetrics;
   get billableMetrics(): BillableMetrics {
     return (this._billableMetrics ??= new BillableMetrics(this._options));