refactor: update service descriptions with new names

bump package version 1.6.0

Author: AmirAref

magicalapi/services/company_data_service.py

@@ -1,5 +1,5 @@
 """
-this file stores the implementation of company data Service.
+this file stores the implementation of LinkedIn Company Scraper Service.
 https://magicalapi.com/services/company-data
 
 """
@@ -24,7 +24,7 @@ async def get_company_data(
         company_name: str | None = None,
         company_website: str | None = None,
     ) -> CompanyDataResponse | WebhookCreatedResponse | ErrorResponse:
-        """this method sends request to company data service in magicalAPI.
+        """this method sends request to LinkedIn Company Scraper service in magicalAPI.
         https://magicalapi.com/services/company-data
 
         company_name (``str``):

magicalapi/services/profile_data_service.py

@@ -1,5 +1,5 @@
 """
-this file stores the implementation of profile data Service.
+this file stores the implementation of LinkedIn Profile Scraper Service.
 https://magicalapi.com/services/profile-data
 
 """
@@ -21,7 +21,7 @@ class ProfileDataService(BaseService):
     async def get_profile_data(
         self, profile_name: str
     ) -> ProfileDataResponse | WebhookCreatedResponse | ErrorResponse:
-        """this method sends request to profile data service in magicalAPI.
+        """this method sends request to LinkedIn Profile Scraper service in magicalAPI.
         https://magicalapi.com/services/profile-data
 
         profile_name (``str``):
@@ -49,4 +49,4 @@ async def get_profile_data(
     def validate_response(
         self, response: HttpResponse, validate_model: type[BaseModel]
     ) -> ProfileDataResponse | WebhookCreatedResponse | ErrorResponse:
-        return super().validate_response(response, validate_model)  # type:ignore
+        return super().validate_response(response, validate_model)  # type: ignore

magicalapi/services/resume_review_service.py

@@ -1,5 +1,5 @@
 """
-this file stores the implementation of resume review Service.
+this file stores the implementation of Resume Checker(Review) Service.
 https://magicalapi.com/services/resume-review
 
 """
@@ -19,7 +19,7 @@ class ResumeReviewService(BaseService):
     async def get_resume_review(
         self, url: str
     ) -> ResumeReviewResponse | WebhookCreatedResponse | ErrorResponse:
-        """this method sends request to resume review service in magicalAPI.
+        """this method sends request to Resume Checker(Review) service in magicalAPI.
         https://magicalapi.com/services/resume-review
 
         url (``str``):

magicalapi/services/resume_score_service.py

@@ -1,5 +1,5 @@
 """
-this file stores the implementation of resume score Service.
+this file stores the implementation of Resume Matcher(Score) Service.
 https://magicalapi.com/services/resume-score
 
 """
@@ -19,7 +19,7 @@ class ResumeScoreService(BaseService):
     async def get_resume_score(
         self, url: str, job_description: str
     ) -> ResumeScoreResponse | WebhookCreatedResponse | ErrorResponse:
-        """this method sends request to resume score service in magicalAPI.
+        """this method sends request to Resume Matcher(Score) service in magicalAPI.
         https://magicalapi.com/services/resume-score
 
         url (``str``):
@@ -36,7 +36,9 @@ async def get_resume_score(
 
         """
         if not 100 <= len(job_description) <= 5000:
-            raise ValueError("job_description must be between 100 and 5000 characters long")
+            raise ValueError(
+                "job_description must be between 100 and 5000 characters long"
+            )
 
         request_body = {
             "url": url,

magicalapi/types/company_data.py

@@ -64,7 +64,7 @@ class Funding(BaseModelValidated):
 
 class Company(BaseModelValidated):
     """
-    The main type of company data service
+    The main type of LinkedIn Company Scraper service
     """
 
     url: str

magicalapi/types/profile_data.py

@@ -151,7 +151,7 @@ class Patent(BaseModelValidated):
 
 class Profile(BaseModelValidated):
     """
-    The main type of linkedin profile data service
+    The main type of LinkedIn Profile Scraper service
     """
 
     url: str

magicalapi/types/resume_review.py

@@ -1,5 +1,5 @@
 """
-types schem of resume review service
+types schema of Resume Checker(Review) service
 
 """
 

magicalapi/types/resume_score.py

@@ -1,5 +1,5 @@
 """
-types schem of resume score service
+types schema of Resume Matcher(Score) service
 https://magicalapi.com/services/resume-score
 """
 
@@ -11,8 +11,6 @@
 from typing import Literal
 from pydantic import BaseModel
 
-
-
 Category = Literal[
     "job",
     "education",
@@ -99,7 +97,7 @@ class ScoreResponse(BaseModelValidated):
 
 class ResumeScoreResponse(BaseResponse):
     """
-    the main resposne schema for resume score service
+    the main resposne schema for Resume Matcher(Score) service
     https://magicalapi.com/services/resume-score
     """
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "magicalapi"
-version = "1.5.2"
+version = "1.6.0"
 description = "This is a Python client that provides easy access to the MagicalAPI.com services, fully type annotated, and asynchronous."
 authors = [
     { name = "MagicalAPI", email = "info@magicalapi.com" }