rxfoundry.clients.swifty-api 0.0.680__py3-none-any.whl → 0.1.1005__py3-none-any.whl

rxfoundry/clients/swifty_api/api/pharmacist_api.py

@@ -304,10 +304,10 @@ class PharmacistApi:
     @validate_call
     def get_pharmacists(
         self,
-        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query")] = None,
-        page: Optional[StrictInt] = None,
-        results_per_page: Optional[StrictInt] = None,
-        deep: Optional[StrictBool] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query.  Searches on NPI, first name, last name, practice address street one, practice address city, practice address state.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="Page number to return.  Defaults to 1.")] = None,
+        results_per_page: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.  Defaults to 10.")] = None,
+        deep: Annotated[Optional[StrictBool], Field(description="Returned contained objects for the pharmacist or just minimal information.  Defaults to false.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -324,13 +324,13 @@ class PharmacistApi:
         """Get all pharmacists
 
 
-        :param q: Filter medications by query
+        :param q: Filter medications by query.  Searches on NPI, first name, last name, practice address street one, practice address city, practice address state.
         :type q: str
-        :param page:
+        :param page: Page number to return.  Defaults to 1.
         :type page: int
-        :param results_per_page:
+        :param results_per_page: Number of results to return per page.  Defaults to 10.
         :type results_per_page: int
-        :param deep:
+        :param deep: Returned contained objects for the pharmacist or just minimal information.  Defaults to false.
         :type deep: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -383,10 +383,10 @@ class PharmacistApi:
     @validate_call
     def get_pharmacists_with_http_info(
         self,
-        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query")] = None,
-        page: Optional[StrictInt] = None,
-        results_per_page: Optional[StrictInt] = None,
-        deep: Optional[StrictBool] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query.  Searches on NPI, first name, last name, practice address street one, practice address city, practice address state.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="Page number to return.  Defaults to 1.")] = None,
+        results_per_page: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.  Defaults to 10.")] = None,
+        deep: Annotated[Optional[StrictBool], Field(description="Returned contained objects for the pharmacist or just minimal information.  Defaults to false.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -403,13 +403,13 @@ class PharmacistApi:
         """Get all pharmacists
 
 
-        :param q: Filter medications by query
+        :param q: Filter medications by query.  Searches on NPI, first name, last name, practice address street one, practice address city, practice address state.
         :type q: str
-        :param page:
+        :param page: Page number to return.  Defaults to 1.
         :type page: int
-        :param results_per_page:
+        :param results_per_page: Number of results to return per page.  Defaults to 10.
         :type results_per_page: int
-        :param deep:
+        :param deep: Returned contained objects for the pharmacist or just minimal information.  Defaults to false.
         :type deep: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -462,10 +462,10 @@ class PharmacistApi:
     @validate_call
     def get_pharmacists_without_preload_content(
         self,
-        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query")] = None,
-        page: Optional[StrictInt] = None,
-        results_per_page: Optional[StrictInt] = None,
-        deep: Optional[StrictBool] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query.  Searches on NPI, first name, last name, practice address street one, practice address city, practice address state.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="Page number to return.  Defaults to 1.")] = None,
+        results_per_page: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.  Defaults to 10.")] = None,
+        deep: Annotated[Optional[StrictBool], Field(description="Returned contained objects for the pharmacist or just minimal information.  Defaults to false.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -482,13 +482,13 @@ class PharmacistApi:
         """Get all pharmacists
 
 
-        :param q: Filter medications by query
+        :param q: Filter medications by query.  Searches on NPI, first name, last name, practice address street one, practice address city, practice address state.
         :type q: str
-        :param page:
+        :param page: Page number to return.  Defaults to 1.
         :type page: int
-        :param results_per_page:
+        :param results_per_page: Number of results to return per page.  Defaults to 10.
         :type results_per_page: int
-        :param deep:
+        :param deep: Returned contained objects for the pharmacist or just minimal information.  Defaults to false.
         :type deep: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

rxfoundry/clients/swifty_api/api/pharmacy_api.py

@@ -43,14 +43,14 @@ class PharmacyApi:
     @validate_call
     def get_pharmacies(
         self,
-        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query")] = None,
-        networks: Optional[List[StrictStr]] = None,
-        near: Optional[StrictStr] = None,
-        distance: Optional[StrictInt] = None,
-        pricing_program: Optional[StrictStr] = None,
-        page: Optional[StrictInt] = None,
-        results_per_page: Optional[StrictInt] = None,
-        deep: Optional[StrictBool] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query.  Searches on NPI, first name, last name, practice address street one,  practice address city, practice address state, pharmacy networks and taxonomy codes.  Takes precedence  over other filters if set to anything other that '*' ")] = None,
+        networks: Annotated[Optional[List[StrictStr]], Field(description="Filter pharmacies by network(s) using the network names. q has to be set to '*' for this to work.")] = None,
+        near: Annotated[Optional[StrictStr], Field(description="The lat,lon to search near.  q has to be set to '*' for this to work and distance has to be set.")] = None,
+        distance: Annotated[Optional[StrictInt], Field(description="The distance to search, in miles from the lat,lon location.  q has to be set to '*' for this to work.")] = None,
+        pricing_program: Annotated[Optional[StrictStr], Field(description="The pricing program to return pricing program data for.  Only one pricing program can be passed in at a time.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="Page number to return.  Defaults to 1.")] = None,
+        results_per_page: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.  Defaults to 10.")] = None,
+        deep: Annotated[Optional[StrictBool], Field(description="Returned contained objects for the pharmacy or just minimal information.  Defaults to false.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -67,21 +67,21 @@ class PharmacyApi:
         """Get all pharmacies
 
 
-        :param q: Filter medications by query
+        :param q: Filter medications by query.  Searches on NPI, first name, last name, practice address street one,  practice address city, practice address state, pharmacy networks and taxonomy codes.  Takes precedence  over other filters if set to anything other that '*' 
         :type q: str
-        :param networks:
+        :param networks: Filter pharmacies by network(s) using the network names. q has to be set to '*' for this to work.
         :type networks: List[str]
-        :param near:
+        :param near: The lat,lon to search near.  q has to be set to '*' for this to work and distance has to be set.
         :type near: str
-        :param distance:
+        :param distance: The distance to search, in miles from the lat,lon location.  q has to be set to '*' for this to work.
         :type distance: int
-        :param pricing_program:
+        :param pricing_program: The pricing program to return pricing program data for.  Only one pricing program can be passed in at a time.
         :type pricing_program: str
-        :param page:
+        :param page: Page number to return.  Defaults to 1.
         :type page: int
-        :param results_per_page:
+        :param results_per_page: Number of results to return per page.  Defaults to 10.
         :type results_per_page: int
-        :param deep:
+        :param deep: Returned contained objects for the pharmacy or just minimal information.  Defaults to false.
         :type deep: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -138,14 +138,14 @@ class PharmacyApi:
     @validate_call
     def get_pharmacies_with_http_info(
         self,
-        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query")] = None,
-        networks: Optional[List[StrictStr]] = None,
-        near: Optional[StrictStr] = None,
-        distance: Optional[StrictInt] = None,
-        pricing_program: Optional[StrictStr] = None,
-        page: Optional[StrictInt] = None,
-        results_per_page: Optional[StrictInt] = None,
-        deep: Optional[StrictBool] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query.  Searches on NPI, first name, last name, practice address street one,  practice address city, practice address state, pharmacy networks and taxonomy codes.  Takes precedence  over other filters if set to anything other that '*' ")] = None,
+        networks: Annotated[Optional[List[StrictStr]], Field(description="Filter pharmacies by network(s) using the network names. q has to be set to '*' for this to work.")] = None,
+        near: Annotated[Optional[StrictStr], Field(description="The lat,lon to search near.  q has to be set to '*' for this to work and distance has to be set.")] = None,
+        distance: Annotated[Optional[StrictInt], Field(description="The distance to search, in miles from the lat,lon location.  q has to be set to '*' for this to work.")] = None,
+        pricing_program: Annotated[Optional[StrictStr], Field(description="The pricing program to return pricing program data for.  Only one pricing program can be passed in at a time.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="Page number to return.  Defaults to 1.")] = None,
+        results_per_page: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.  Defaults to 10.")] = None,
+        deep: Annotated[Optional[StrictBool], Field(description="Returned contained objects for the pharmacy or just minimal information.  Defaults to false.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -162,21 +162,21 @@ class PharmacyApi:
         """Get all pharmacies
 
 
-        :param q: Filter medications by query
+        :param q: Filter medications by query.  Searches on NPI, first name, last name, practice address street one,  practice address city, practice address state, pharmacy networks and taxonomy codes.  Takes precedence  over other filters if set to anything other that '*' 
         :type q: str
-        :param networks:
+        :param networks: Filter pharmacies by network(s) using the network names. q has to be set to '*' for this to work.
         :type networks: List[str]
-        :param near:
+        :param near: The lat,lon to search near.  q has to be set to '*' for this to work and distance has to be set.
         :type near: str
-        :param distance:
+        :param distance: The distance to search, in miles from the lat,lon location.  q has to be set to '*' for this to work.
         :type distance: int
-        :param pricing_program:
+        :param pricing_program: The pricing program to return pricing program data for.  Only one pricing program can be passed in at a time.
         :type pricing_program: str
-        :param page:
+        :param page: Page number to return.  Defaults to 1.
         :type page: int
-        :param results_per_page:
+        :param results_per_page: Number of results to return per page.  Defaults to 10.
         :type results_per_page: int
-        :param deep:
+        :param deep: Returned contained objects for the pharmacy or just minimal information.  Defaults to false.
         :type deep: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -233,14 +233,14 @@ class PharmacyApi:
     @validate_call
     def get_pharmacies_without_preload_content(
         self,
-        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query")] = None,
-        networks: Optional[List[StrictStr]] = None,
-        near: Optional[StrictStr] = None,
-        distance: Optional[StrictInt] = None,
-        pricing_program: Optional[StrictStr] = None,
-        page: Optional[StrictInt] = None,
-        results_per_page: Optional[StrictInt] = None,
-        deep: Optional[StrictBool] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query.  Searches on NPI, first name, last name, practice address street one,  practice address city, practice address state, pharmacy networks and taxonomy codes.  Takes precedence  over other filters if set to anything other that '*' ")] = None,
+        networks: Annotated[Optional[List[StrictStr]], Field(description="Filter pharmacies by network(s) using the network names. q has to be set to '*' for this to work.")] = None,
+        near: Annotated[Optional[StrictStr], Field(description="The lat,lon to search near.  q has to be set to '*' for this to work and distance has to be set.")] = None,
+        distance: Annotated[Optional[StrictInt], Field(description="The distance to search, in miles from the lat,lon location.  q has to be set to '*' for this to work.")] = None,
+        pricing_program: Annotated[Optional[StrictStr], Field(description="The pricing program to return pricing program data for.  Only one pricing program can be passed in at a time.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="Page number to return.  Defaults to 1.")] = None,
+        results_per_page: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.  Defaults to 10.")] = None,
+        deep: Annotated[Optional[StrictBool], Field(description="Returned contained objects for the pharmacy or just minimal information.  Defaults to false.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -257,21 +257,21 @@ class PharmacyApi:
         """Get all pharmacies
 
 
-        :param q: Filter medications by query
+        :param q: Filter medications by query.  Searches on NPI, first name, last name, practice address street one,  practice address city, practice address state, pharmacy networks and taxonomy codes.  Takes precedence  over other filters if set to anything other that '*' 
         :type q: str
-        :param networks:
+        :param networks: Filter pharmacies by network(s) using the network names. q has to be set to '*' for this to work.
         :type networks: List[str]
-        :param near:
+        :param near: The lat,lon to search near.  q has to be set to '*' for this to work and distance has to be set.
         :type near: str
-        :param distance:
+        :param distance: The distance to search, in miles from the lat,lon location.  q has to be set to '*' for this to work.
         :type distance: int
-        :param pricing_program:
+        :param pricing_program: The pricing program to return pricing program data for.  Only one pricing program can be passed in at a time.
         :type pricing_program: str
-        :param page:
+        :param page: Page number to return.  Defaults to 1.
         :type page: int
-        :param results_per_page:
+        :param results_per_page: Number of results to return per page.  Defaults to 10.
         :type results_per_page: int
-        :param deep:
+        :param deep: Returned contained objects for the pharmacy or just minimal information.  Defaults to false.
         :type deep: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

rxfoundry/clients/swifty_api/api/prescriber_api.py

@@ -304,10 +304,10 @@ class PrescriberApi:
     @validate_call
     def get_prescribers(
         self,
-        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query")] = None,
-        page: Optional[StrictInt] = None,
-        results_per_page: Optional[StrictInt] = None,
-        deep: Optional[StrictBool] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Filter prescribers by query.  Searches by NPI, first name, last name, practice address street one, practice address city, practice address state.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="The page number to return.  Defaults to 1.")] = None,
+        results_per_page: Annotated[Optional[StrictInt], Field(description="The number of results to return per page.  Defaults to 10.")] = None,
+        deep: Annotated[Optional[StrictBool], Field(description="Whether to return contained objecst for the prescriber or just minimal information.  Defaults to false.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -324,13 +324,13 @@ class PrescriberApi:
         """Get all prescribers
 
 
-        :param q: Filter medications by query
+        :param q: Filter prescribers by query.  Searches by NPI, first name, last name, practice address street one, practice address city, practice address state.
         :type q: str
-        :param page:
+        :param page: The page number to return.  Defaults to 1.
         :type page: int
-        :param results_per_page:
+        :param results_per_page: The number of results to return per page.  Defaults to 10.
         :type results_per_page: int
-        :param deep:
+        :param deep: Whether to return contained objecst for the prescriber or just minimal information.  Defaults to false.
         :type deep: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -383,10 +383,10 @@ class PrescriberApi:
     @validate_call
     def get_prescribers_with_http_info(
         self,
-        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query")] = None,
-        page: Optional[StrictInt] = None,
-        results_per_page: Optional[StrictInt] = None,
-        deep: Optional[StrictBool] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Filter prescribers by query.  Searches by NPI, first name, last name, practice address street one, practice address city, practice address state.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="The page number to return.  Defaults to 1.")] = None,
+        results_per_page: Annotated[Optional[StrictInt], Field(description="The number of results to return per page.  Defaults to 10.")] = None,
+        deep: Annotated[Optional[StrictBool], Field(description="Whether to return contained objecst for the prescriber or just minimal information.  Defaults to false.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -403,13 +403,13 @@ class PrescriberApi:
         """Get all prescribers
 
 
-        :param q: Filter medications by query
+        :param q: Filter prescribers by query.  Searches by NPI, first name, last name, practice address street one, practice address city, practice address state.
         :type q: str
-        :param page:
+        :param page: The page number to return.  Defaults to 1.
         :type page: int
-        :param results_per_page:
+        :param results_per_page: The number of results to return per page.  Defaults to 10.
         :type results_per_page: int
-        :param deep:
+        :param deep: Whether to return contained objecst for the prescriber or just minimal information.  Defaults to false.
         :type deep: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -462,10 +462,10 @@ class PrescriberApi:
     @validate_call
     def get_prescribers_without_preload_content(
         self,
-        q: Annotated[Optional[StrictStr], Field(description="Filter medications by query")] = None,
-        page: Optional[StrictInt] = None,
-        results_per_page: Optional[StrictInt] = None,
-        deep: Optional[StrictBool] = None,
+        q: Annotated[Optional[StrictStr], Field(description="Filter prescribers by query.  Searches by NPI, first name, last name, practice address street one, practice address city, practice address state.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="The page number to return.  Defaults to 1.")] = None,
+        results_per_page: Annotated[Optional[StrictInt], Field(description="The number of results to return per page.  Defaults to 10.")] = None,
+        deep: Annotated[Optional[StrictBool], Field(description="Whether to return contained objecst for the prescriber or just minimal information.  Defaults to false.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -482,13 +482,13 @@ class PrescriberApi:
         """Get all prescribers
 
 
-        :param q: Filter medications by query
+        :param q: Filter prescribers by query.  Searches by NPI, first name, last name, practice address street one, practice address city, practice address state.
         :type q: str
-        :param page:
+        :param page: The page number to return.  Defaults to 1.
         :type page: int
-        :param results_per_page:
+        :param results_per_page: The number of results to return per page.  Defaults to 10.
         :type results_per_page: int
-        :param deep:
+        :param deep: Whether to return contained objecst for the prescriber or just minimal information.  Defaults to false.
         :type deep: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request