Back to Changelog

SDK Method Reorganization

sdkbreaking

SDK v0.2.0 -- Method Reorganization

Both the TypeScript and Python SDKs have been updated with corrected method locations and names to match the API endpoint structure.

Breaking Changes

Credentials -- Moved from organizations to inboxes resource:

  • TypeScript: client.organizations.getCredentials(id) -> client.inboxes.getCredentials(id)
  • Python: client.organizations.get_credentials(id) -> client.inboxes.get_credentials(id)

Governance -> Policies -- Renamed to match API path /org/policies:

  • TypeScript: getPolicies() / updatePolicies() (was getGovernance() / updateGovernance())
  • Python: get_policies() / update_policies() (was get_governance() / update_governance())

Metrics -- New dedicated metrics resource with 3 endpoint-specific methods:

  • client.metrics.getActivity(params) -- GET /metrics/activity
  • client.metrics.getDeliverability(params) -- GET /metrics/deliverability
  • client.metrics.getSummary(params) -- GET /metrics/summary

Previously, metrics was a single getMetrics() method on the organizations resource that did not match any API endpoint.

OpenAPI Spec

Duplicate admin paths that appeared at root level (without /api/v1 prefix) have been filtered from the generated OpenAPI specification.