Standardize list types

[narekhovhannisyan]

Motivation

use the same standard for the list types across APIs

Summary by CodeRabbit

• Chores
  • Removed unused type aliases related to contact lists and templates.
  • Updated internal type annotations for improved consistency.
  • Added a trailing newline to the end of the README file.

[coderabbitai]

Walkthrough

This update removes the ContactLists and TemplateList type aliases, replacing their usage with explicit array types. The affected API and test code now use direct array typings for ContactList and Template objects. A trailing newline was also added to the README.md file.

Changes

Files/Groups	Change Summary
src/types/api/contactlist.ts, src/types/api/templates.ts	Removed ContactLists and TemplateList type aliases (previously arrays of ContactList/Template).
src/lib/api/resources/ContactLists.ts	Updated Axios call return type from ContactLists to ContactList[]; removed unused import.
src/tests/lib/api/resources/ContactLists.test.ts	Changed test type annotation from ContactLists to ContactList[]; cleaned up imports.
README.md	Added a single trailing newline at the end of the file.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ContactListsApi
    participant Server

    Client->>ContactListsApi: getList()
    ContactListsApi->>Server: GET /contact-lists
    Server-->>ContactListsApi: [ContactList, ...]
    ContactListsApi-->>Client: [ContactList, ...]

Loading

Possibly related PRs

• Contacts api #64: Introduces a new ContactsApi class and integrates contacts and contact lists APIs, related by involvement with contact list API typings.
• Contact lists api #65: Implements the ContactListsApi class and related types, directly related as the current changes build upon this code.

Suggested labels

feature request

Suggested reviewers

• mklocek
• vittorius

Poem

A hop and a skip through the code we go,
Trimming the types so arrays can flow.
No more aliases hiding in the grass,
Just simple lists, clear and fast!
With a newline at the end,
This rabbit’s work is done, my friend.
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d98f1b2 and b97f49f.

📒 Files selected for processing (5)

• README.md (1 hunks)
• src/__tests__/lib/api/resources/ContactLists.test.ts (2 hunks)
• src/lib/api/resources/ContactLists.ts (1 hunks)
• src/types/api/contactlist.ts (0 hunks)
• src/types/api/templates.ts (0 hunks)

💤 Files with no reviewable changes (2)

• src/types/api/templates.ts
• src/types/api/contactlist.ts

🧰 Additional context used

🧬 Code Graph Analysis (2)

src/__tests__/lib/api/resources/ContactLists.test.ts (1)

src/types/api/contactlist.ts (1)

• ContactList (1-4)

src/lib/api/resources/ContactLists.ts (1)

src/types/api/contactlist.ts (1)

• ContactList (1-4)

🔇 Additional comments (4)

README.md (1)

149-149: LGTM! Minor formatting improvement.

Adding a trailing newline is a good practice for text files and aligns with many coding standards.

src/__tests__/lib/api/resources/ContactLists.test.ts (2)

7-7: LGTM! Correctly updated import to remove the type alias.

The import change properly removes the ContactLists type alias, maintaining only the base ContactList type needed for the tests.

---

64-64: LGTM! Consistent type annotation change.

The type annotation correctly changes from the removed ContactLists type alias to the explicit ContactList[] array type, maintaining consistency with the standardization effort.

src/lib/api/resources/ContactLists.ts (1)

28-28: All removed ContactLists type aliases have been purged and only class references remain

I searched across the codebase for any remaining uses of the ContactLists type alias (e.g. generic parameters, type annotations) and found none—every ContactLists occurrence now refers to the API classes, not a type alias. Likewise, there are no stray TemplateList aliases. This change is safe to merge.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.