Refactor SDK types and rename repository subscription methods#73
Merged
Refactor SDK types and rename repository subscription methods#73
Conversation
## Summary This update refines the SDK type definitions by renaming and restructuring types related to repository subscriptions, enhancing clarity and usability. ## Changes Made - **Renamed Types**: Changed `CreateRepositorySubscriptionData` to `ChangeRepositoryPlanData` and updated related types to reflect the new naming convention. - **Updated Documentation**: Adjusted comments to clarify the purpose of the new types and their parameters. - **Modified Response Types**: Updated response types to align with the new naming and functionality, ensuring consistency across the SDK. ## Key Benefits - **Improved Clarity**: The renaming of types provides a clearer understanding of their purpose, aiding developers in utilizing the SDK effectively. - **Enhanced Usability**: The updated types and documentation improve the overall developer experience when working with repository subscriptions. ## Breaking Changes - Existing code relying on the previous type names will need to be updated to accommodate the new naming conventions. ## Testing Notes for Reviewers - Verify that all references to the renamed types are updated throughout the codebase. - Ensure that the SDK compiles without errors and that the new types integrate correctly into existing workflows.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR refactors the SDK layer by updating generated types and renaming repository subscription-related methods for improved clarity and consistency. The changes span the SDK's core files —
index.ts,sdk.gen.ts, andtypes.gen.ts— affecting type definitions, method signatures, and re-exports.Changes
SDK Type Refactoring (
types.gen.ts)SDK Method Renaming (
sdk.gen.ts)Re-exports (
index.ts)Breaking Changes⚠️
Yes — this is a breaking change for SDK consumers.
sdk/types.gen.tsor calling methods fromsdk/sdk.gen.tsmust migrate to the new names.Key Improvements
UI/UX Impact
Testing Notes for Reviewers
tsc --noEmitto confirm there are no type errors introduced by the rename.sdk.gen.tsandtypes.gen.tswere regenerated correctly from the API schema (if applicable) and that no manual edits conflict with the code generator.Browser Compatibility
No browser compatibility concerns — changes are limited to TypeScript SDK types and method definitions that compile down to standard JavaScript. No new browser APIs or polyfills are introduced.
🤖 Generated with Claude Code
Branch Info:
feature/repo-sub-changemainCo-Authored-By: Claude noreply@anthropic.com