USPTO Open Data Portal

Synchronous

Manager

Models

class patent_client._sync.uspto.odp.model.BaseODPModel

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_fields: ClassVar[dict[str, FieldInfo]] = {}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Address(*, cityName: Optional[str] = None, geographicRegionName: Optional[str] = None, geographicRegionCode: Optional[str] = None, countryCode: Optional[str] = None, postalCode: Optional[str] = None, countryName: Optional[str] = None, addressLineOneText: Optional[str] = None, addressLineTwoText: Optional[str] = None, nameLineOneText: Optional[str] = None, nameLineTwoText: Optional[str] = None, postalAddressCategory: Optional[str] = None, correspondentNameText: Optional[str] = None)

city_name: Optional[str]

geographic_region_name: Optional[str]

geographic_region_code: Optional[str]

country_code: Optional[str]

postal_code: Optional[str]

country_name: Optional[str]

address_line_one_text: Optional[str]

address_line_two_text: Optional[str]

name_line_one_text: Optional[str]

name_line_two_text: Optional[str]

postal_address_category: Optional[str]

correspondent_name_text: Optional[str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'address_line_one_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='addressLineOneText', alias_priority=2), 'address_line_two_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='addressLineTwoText', alias_priority=2), 'city_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='cityName', alias_priority=2), 'correspondent_name_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='correspondentNameText', alias_priority=2), 'country_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='countryCode', alias_priority=2), 'country_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='countryName', alias_priority=2), 'geographic_region_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='geographicRegionCode', alias_priority=2), 'geographic_region_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='geographicRegionName', alias_priority=2), 'name_line_one_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='nameLineOneText', alias_priority=2), 'name_line_two_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='nameLineTwoText', alias_priority=2), 'postal_address_category': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='postalAddressCategory', alias_priority=2), 'postal_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='postalCode', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Relationship(*, applicationStatusCode: int, claimParentageTypeCode: str, filingDate: date, applicationStatusDescriptionText: str, claimParentageTypeCodeDescription: str, parentApplicationNumberText: str, childApplicationNumberText: str)

application_status_code: int

claim_type_code: str

filing_date: date

application_status_description: str

claim_type_description: str

parent_application_id: str

child_application_id: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'application_status_code': FieldInfo(annotation=int, required=True, alias='applicationStatusCode', alias_priority=1), 'application_status_description': FieldInfo(annotation=str, required=True, alias='applicationStatusDescriptionText', alias_priority=2), 'child_application_id': FieldInfo(annotation=str, required=True, alias='childApplicationNumberText', alias_priority=2), 'claim_type_code': FieldInfo(annotation=str, required=True, alias='claimParentageTypeCode', alias_priority=2), 'claim_type_description': FieldInfo(annotation=str, required=True, alias='claimParentageTypeCodeDescription', alias_priority=2), 'filing_date': FieldInfo(annotation=date, required=True, alias='filingDate', alias_priority=1), 'parent_application_id': FieldInfo(annotation=str, required=True, alias='parentApplicationNumberText', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Continuity(*, count: int, requestIdentifier: str, parent_continuity: Optional[list[patent_client._sync.uspto.odp.model.Relationship]] = None, child_continuity: Optional[list[patent_client._sync.uspto.odp.model.Relationship]] = None)

count: int

request_identifier: str

parent_continuity: Optional[list[patent_client._sync.uspto.odp.model.Relationship]]

child_continuity: Optional[list[patent_client._sync.uspto.odp.model.Relationship]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'child_continuity': FieldInfo(annotation=Union[list[Relationship], NoneType], required=False, default=None, alias=AliasPath(path=[['patentBag', 0, 'continuityBag', 'childContinuityBag']]), alias_priority=2, serialization_alias='childContinuity'), 'count': FieldInfo(annotation=int, required=True, alias='count', alias_priority=1), 'parent_continuity': FieldInfo(annotation=Union[list[Relationship], NoneType], required=False, default=None, alias=AliasPath(path=[['patentBag', 0, 'continuityBag', 'parentContinuityBag']]), alias_priority=2, serialization_alias='parentContinuity'), 'request_identifier': FieldInfo(annotation=str, required=True, alias='requestIdentifier', alias_priority=1)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.DownloadOption(*, mimeTypeIdentifier: str, downloadUrl: str, pageTotalQuantity: int)

mime_type_identifier: str

download_url: str

pages: int

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'download_url': FieldInfo(annotation=str, required=True, alias='downloadUrl', alias_priority=1), 'mime_type_identifier': FieldInfo(annotation=str, required=True, alias='mimeTypeIdentifier', alias_priority=1), 'pages': FieldInfo(annotation=int, required=True, alias='pageTotalQuantity', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Document(*, applicationNumberText: str, officialDate: datetime, documentIdentifier: str, documentCode: str, documentCodeDescriptionText: str, directionCategory: str, downloadOptionBag: list[dict])

appl_id: str

mail_date: datetime

document_identifier: str

document_code: str

document_code_description: str

direction_category: str

download_option_bag: list[dict]

download(type='PDF', out_path=None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'appl_id': FieldInfo(annotation=str, required=True, alias='applicationNumberText', alias_priority=2), 'direction_category': FieldInfo(annotation=str, required=True, alias='directionCategory', alias_priority=2), 'document_code': FieldInfo(annotation=str, required=True, alias='documentCode', alias_priority=2), 'document_code_description': FieldInfo(annotation=str, required=True, alias='documentCodeDescriptionText', alias_priority=2), 'document_identifier': FieldInfo(annotation=str, required=True, alias='documentIdentifier', alias_priority=2), 'download_option_bag': FieldInfo(annotation=list[dict], required=True, alias='downloadOptionBag', alias_priority=2), 'mail_date': FieldInfo(annotation=datetime, required=True, alias='officialDate', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Assignor(*, executionDate: date, assignorName: str)

execution_date: date

assignor_name: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'assignor_name': FieldInfo(annotation=str, required=True, alias='assignorName', alias_priority=2), 'execution_date': FieldInfo(annotation=date, required=True, alias='executionDate', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.AssigneeAddress(*, cityName: str, geographicRegionCode: str, postalCode: str, addressLineOneText: str)

city_name: str

geographic_region_code: str

postal_code: str

address_line_one_text: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'address_line_one_text': FieldInfo(annotation=str, required=True, alias='addressLineOneText', alias_priority=2), 'city_name': FieldInfo(annotation=str, required=True, alias='cityName', alias_priority=2), 'geographic_region_code': FieldInfo(annotation=str, required=True, alias='geographicRegionCode', alias_priority=2), 'postal_code': FieldInfo(annotation=str, required=True, alias='postalCode', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Assignee(*, assigneeAddress: AssigneeAddress, assigneeNameText: str)

assignee_address: AssigneeAddress

assignee_name_text: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'assignee_address': FieldInfo(annotation=AssigneeAddress, required=True, alias='assigneeAddress', alias_priority=2), 'assignee_name_text': FieldInfo(annotation=str, required=True, alias='assigneeNameText', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Assignment(*, assignmentReceivedDate: date, frameNumber: str, pageNumber: int, reel_number_frame_number: str, assignmentRecordedDate: date, conveyanceText: str, assignmentMailedDate: date, reelNumber: str, assignorBag: list[patent_client._sync.uspto.odp.model.Assignor], assigneeBag: list[patent_client._sync.uspto.odp.model.Assignee], correspondenceAddress: list[patent_client._sync.uspto.odp.model.Address])

assignment_received_date: date

frame_number: str

page_number: int

reel_number_frame_number: str

assignment_recorded_date: date

conveyance_text: str

assignment_mailed_date: date

reel_number: str

assignor_bag: list[patent_client._sync.uspto.odp.model.Assignor]

assignee_bag: list[patent_client._sync.uspto.odp.model.Assignee]

correspondence_address: list[patent_client._sync.uspto.odp.model.Address]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'assignee_bag': FieldInfo(annotation=list[Assignee], required=True, alias='assigneeBag', alias_priority=2), 'assignment_mailed_date': FieldInfo(annotation=date, required=True, alias='assignmentMailedDate', alias_priority=2), 'assignment_received_date': FieldInfo(annotation=date, required=True, alias='assignmentReceivedDate', alias_priority=2), 'assignment_recorded_date': FieldInfo(annotation=date, required=True, alias='assignmentRecordedDate', alias_priority=2), 'assignor_bag': FieldInfo(annotation=list[Assignor], required=True, alias='assignorBag', alias_priority=2), 'conveyance_text': FieldInfo(annotation=str, required=True, alias='conveyanceText', alias_priority=2), 'correspondence_address': FieldInfo(annotation=list[Address], required=True, alias='correspondenceAddress', alias_priority=2), 'frame_number': FieldInfo(annotation=str, required=True, alias='frameNumber', alias_priority=2), 'page_number': FieldInfo(annotation=int, required=True, alias='pageNumber', alias_priority=2), 'reel_number': FieldInfo(annotation=str, required=True, alias='reelNumber', alias_priority=2), 'reel_number_frame_number': FieldInfo(annotation=str, required=True, alias='reelNumber/frameNumber', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.ForeignPriority(*, priorityNumberText: str, filingDate: date, countryName: str)

priority_number_text: str

filing_date: date

country_name: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'country_name': FieldInfo(annotation=str, required=True, alias='countryName', alias_priority=2), 'filing_date': FieldInfo(annotation=date, required=True, alias='filingDate', alias_priority=2), 'priority_number_text': FieldInfo(annotation=str, required=True, alias='priorityNumberText', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.TelecommunicationAddress(*, telecommunicationNumber: str, usageTypeCategory: str)

telecommunication_number: str

usage_type_category: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'telecommunication_number': FieldInfo(annotation=str, required=True, alias='telecommunicationNumber', alias_priority=2), 'usage_type_category': FieldInfo(annotation=str, required=True, alias='usageTypeCategory', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Attorney(*, activeIndicator: str, firstName: Optional[str] = None, lastName: Optional[str] = None, registrationNumber: str, attorneyAddressBag: list[patent_client._sync.uspto.odp.model.Address], telecommunicationAddressBag: list[patent_client._sync.uspto.odp.model.TelecommunicationAddress], registeredPractitionerCategory: str, nameSuffix: Optional[str] = None)

active_indicator: str

first_name: Optional[str]

last_name: Optional[str]

registration_number: str

attorney_address_bag: list[patent_client._sync.uspto.odp.model.Address]

telecommunication_address_bag: list[patent_client._sync.uspto.odp.model.TelecommunicationAddress]

registered_practitioner_category: str

name_suffix: Optional[str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'active_indicator': FieldInfo(annotation=str, required=True, alias='activeIndicator', alias_priority=2), 'attorney_address_bag': FieldInfo(annotation=list[Address], required=True, alias='attorneyAddressBag', alias_priority=2), 'first_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='firstName', alias_priority=2), 'last_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='lastName', alias_priority=2), 'name_suffix': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='nameSuffix', alias_priority=2), 'registered_practitioner_category': FieldInfo(annotation=str, required=True, alias='registeredPractitionerCategory', alias_priority=2), 'registration_number': FieldInfo(annotation=str, required=True, alias='registrationNumber', alias_priority=2), 'telecommunication_address_bag': FieldInfo(annotation=list[TelecommunicationAddress], required=True, alias='telecommunicationAddressBag', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.CustomerNumber(*, attorneyBag: list[patent_client._sync.uspto.odp.model.Attorney], customer_number: Optional[str], address: Optional[Address])

attorneys: list[patent_client._sync.uspto.odp.model.Attorney]

customer_number: Optional[str]

address: Optional[Address]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'address': FieldInfo(annotation=Union[Address, NoneType], required=True, alias=AliasPath(path=['customerNumber', 'powerOfAttorneyAddressBag', 0]), alias_priority=2, serialization_alias='address'), 'attorneys': FieldInfo(annotation=list[Attorney], required=True, alias='attorneyBag', alias_priority=2), 'customer_number': FieldInfo(annotation=Union[str, NoneType], required=True, alias=AliasPath(path=['customerNumber', 'patronIdentifier']), alias_priority=2, serialization_alias='customerNumber')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Transaction(*, recordedDate: date, caseActionCode: str, caseActionDescriptionText: str)

recorded_date: date

transaction_code: str

transaction_description: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'recorded_date': FieldInfo(annotation=date, required=True, alias='recordedDate', alias_priority=2), 'transaction_code': FieldInfo(annotation=str, required=True, alias='caseActionCode', alias_priority=2), 'transaction_description': FieldInfo(annotation=str, required=True, alias='caseActionDescriptionText', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.TermAdjustmentHistory(*, applicantDayDelayQuantity: int, startSequenceNumber: float, caseActionDescriptionText: str, caseActionSequenceNumber: float, actionDate: date)

applicant_day_delay_quantity: int

start_sequence_number: float

case_action_description_text: str

case_action_sequence_number: float

action_date: date

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'action_date': FieldInfo(annotation=date, required=True, alias='actionDate', alias_priority=2), 'applicant_day_delay_quantity': FieldInfo(annotation=int, required=True, alias='applicantDayDelayQuantity', alias_priority=2), 'case_action_description_text': FieldInfo(annotation=str, required=True, alias='caseActionDescriptionText', alias_priority=2), 'case_action_sequence_number': FieldInfo(annotation=float, required=True, alias='caseActionSequenceNumber', alias_priority=2), 'start_sequence_number': FieldInfo(annotation=float, required=True, alias='startSequenceNumber', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.TermAdjustment(*, applicantDayDelayQuantity: Optional[int] = None, overlappingDayQuantity: Optional[int] = None, filingDate: Optional[date] = None, cDelayQuantity: Optional[int] = None, adjustmentTotalQuantity: Optional[int] = None, bDelayQuantity: Optional[int] = None, grantDate: Optional[date] = None, aDelayQuantity: Optional[int] = None, nonOverlappingDayQuantity: Optional[int] = None, ipOfficeDayDelayQuantity: Optional[int] = None, patentTermAdjustmentHistoryDataBag: Optional[list[patent_client._sync.uspto.odp.model.TermAdjustmentHistory]] = None)

applicant_day_delay_quantity: Optional[int]

overlapping_day_quantity: Optional[int]

filing_date: Optional[date]

c_delay_quantity: Optional[int]

adjustment_total_quantity: Optional[int]

b_delay_quantity: Optional[int]

grant_date: Optional[date]

a_delay_quantity: Optional[int]

non_overlapping_day_quantity: Optional[int]

ip_office_day_delay_quantity: Optional[int]

history: Optional[list[patent_client._sync.uspto.odp.model.TermAdjustmentHistory]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'a_delay_quantity': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='aDelayQuantity', alias_priority=2), 'adjustment_total_quantity': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='adjustmentTotalQuantity', alias_priority=2), 'applicant_day_delay_quantity': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='applicantDayDelayQuantity', alias_priority=2), 'b_delay_quantity': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='bDelayQuantity', alias_priority=2), 'c_delay_quantity': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='cDelayQuantity', alias_priority=2), 'filing_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='filingDate', alias_priority=2), 'grant_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='grantDate', alias_priority=2), 'history': FieldInfo(annotation=Union[list[TermAdjustmentHistory], NoneType], required=False, default=None, alias='patentTermAdjustmentHistoryDataBag', alias_priority=2), 'ip_office_day_delay_quantity': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='ipOfficeDayDelayQuantity', alias_priority=2), 'non_overlapping_day_quantity': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='nonOverlappingDayQuantity', alias_priority=2), 'overlapping_day_quantity': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='overlappingDayQuantity', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Inventor(*, firstName: str, lastName: str, inventorNameText: str, correspondenceAddressBag: list[patent_client._sync.uspto.odp.model.Address])

first_name: str

last_name: str

full_name: str

addresses: list[patent_client._sync.uspto.odp.model.Address]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'addresses': FieldInfo(annotation=list[Address], required=True, alias='correspondenceAddressBag', alias_priority=2), 'first_name': FieldInfo(annotation=str, required=True, alias='firstName', alias_priority=2), 'full_name': FieldInfo(annotation=str, required=True, alias='inventorNameText', alias_priority=2), 'last_name': FieldInfo(annotation=str, required=True, alias='lastName', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Applicant(*, applicantNameText: str, correspondenceAddressBag: list[patent_client._sync.uspto.odp.model.Address], applicationStatusCode: int, applicationStatusDescriptionText: str)

applicant_name: str

addresses: list[patent_client._sync.uspto.odp.model.Address]

app_status_code: int

app_status: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'addresses': FieldInfo(annotation=list[Address], required=True, alias='correspondenceAddressBag', alias_priority=2), 'app_status': FieldInfo(annotation=str, required=True, alias='applicationStatusDescriptionText', alias_priority=2), 'app_status_code': FieldInfo(annotation=int, required=True, alias='applicationStatusCode', alias_priority=2), 'applicant_name': FieldInfo(annotation=str, required=True, alias='applicantNameText', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.USApplicationBiblio(*, firstInventorToFileIndicator: bool, filingDate: ~datetime.date, inventorBag: list[patent_client._sync.uspto.odp.model.Inventor], customerNumber: int = <property object>, groupArtUnitNumber: str, inventionTitle: str, correspondenceAddressBag: list[patent_client._sync.uspto.odp.model.Address], applicationConfirmationNumber: int, docketNumber: str, applicationNumberText: str, firstInventorName: str, firstApplicantName: str, cpcClassificationBag: list[str], businessEntityStatusCategory: str, earliestPublicationNumber: ~typing.Optional[str])

aia_indicator: bool

app_filing_date: date

inventors: list[patent_client._sync.uspto.odp.model.Inventor]

group_art_unit: str

invention_title: str

correspondence_address: list[patent_client._sync.uspto.odp.model.Address]

app_conf_num: int

atty_docket_num: str

appl_id: str

first_inventor_name: str

first_applicant_name: str

cpc_classifications: list[str]

entity_status: str

app_early_pub_number: Optional[str]

property bibliographic_data: USApplicationBiblio

property application: USApplication

property continuity: Continuity

property documents: list[patent_client._sync.uspto.odp.model.Document]

property term_adjustment: TermAdjustment

property assignments: list[patent_client._sync.uspto.odp.model.Assignment]

customer_number: int

property foreign_priority: ForeignPriority

property transactions: list[patent_client._sync.uspto.odp.model.Transaction]

property biblio: USApplicationBiblio

property app: USApplication

property docs: list[patent_client._sync.uspto.odp.model.Document]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'aia_indicator': FieldInfo(annotation=bool, required=True, alias='firstInventorToFileIndicator', alias_priority=2, metadata=[BeforeValidator(func=<function <lambda>>)]), 'app_conf_num': FieldInfo(annotation=int, required=True, alias='applicationConfirmationNumber', alias_priority=2), 'app_early_pub_number': FieldInfo(annotation=Union[str, NoneType], required=True, alias='earliestPublicationNumber', alias_priority=2), 'app_filing_date': FieldInfo(annotation=date, required=True, alias='filingDate', alias_priority=2), 'appl_id': FieldInfo(annotation=str, required=True, alias='applicationNumberText', alias_priority=2), 'atty_docket_num': FieldInfo(annotation=str, required=True, alias='docketNumber', alias_priority=2), 'correspondence_address': FieldInfo(annotation=list[Address], required=True, alias='correspondenceAddressBag', alias_priority=2), 'cpc_classifications': FieldInfo(annotation=list[str], required=True, alias='cpcClassificationBag', alias_priority=2), 'customer_number': FieldInfo(annotation=int, required=False, default=<property object>, alias='customerNumber', alias_priority=1), 'entity_status': FieldInfo(annotation=str, required=True, alias='businessEntityStatusCategory', alias_priority=2), 'first_applicant_name': FieldInfo(annotation=str, required=True, alias='firstApplicantName', alias_priority=2), 'first_inventor_name': FieldInfo(annotation=str, required=True, alias='firstInventorName', alias_priority=2), 'group_art_unit': FieldInfo(annotation=str, required=True, alias='groupArtUnitNumber', alias_priority=2), 'invention_title': FieldInfo(annotation=str, required=True, alias='inventionTitle', alias_priority=2), 'inventors': FieldInfo(annotation=list[Inventor], required=True, alias='inventorBag', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.USApplication(*, firstInventorToFileIndicator: bool, filingDate: date, inventorBag: list[patent_client._sync.uspto.odp.model.Inventor], customerNumber: int, groupArtUnitNumber: str, inventionTitle: str, correspondenceAddressBag: list[patent_client._sync.uspto.odp.model.Address], applicationConfirmationNumber: int, docketNumber: str, applicationNumberText: str, firstInventorName: str, firstApplicantName: str, cpcClassificationBag: list[str], businessEntityStatusCategory: str, earliestPublicationNumber: Optional[str], applicationTypeCode: str, nationalStageIndicator: bool, effectiveFilingDate: date, cls_sub_cls: str, assignmentBag: list[patent_client._sync.uspto.odp.model.Assignment], recordAttorney: CustomerNumber, transactionContentBag: list[patent_client._sync.uspto.odp.model.Transaction], parent_applications: Optional[list[patent_client._sync.uspto.odp.model.Relationship]] = None, child_applications: Optional[list[patent_client._sync.uspto.odp.model.Relationship]] = None, patentTermAdjustmentData: Optional[TermAdjustment])

aia_indicator: bool

app_filing_date: date

inventors: list[patent_client._sync.uspto.odp.model.Inventor]

customer_number: int

group_art_unit: str

invention_title: str

correspondence_address: list[patent_client._sync.uspto.odp.model.Address]

app_conf_num: int

atty_docket_num: str

appl_id: str

first_inventor_name: str

first_applicant_name: str

cpc_classifications: list[str]

entity_status: str

app_early_pub_number: Optional[str]

app_type_code: str

national_stage_indicator: bool

effective_filing_date: date

cls_sub_cls: str

assignments: list[patent_client._sync.uspto.odp.model.Assignment]

attorneys: CustomerNumber

transactions: list[patent_client._sync.uspto.odp.model.Transaction]

parent_applications: Optional[list[patent_client._sync.uspto.odp.model.Relationship]]

child_applications: Optional[list[patent_client._sync.uspto.odp.model.Relationship]]

patent_term_adjustment: Optional[TermAdjustment]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'aia_indicator': FieldInfo(annotation=bool, required=True, alias='firstInventorToFileIndicator', alias_priority=2, metadata=[BeforeValidator(func=<function <lambda>>)]), 'app_conf_num': FieldInfo(annotation=int, required=True, alias='applicationConfirmationNumber', alias_priority=2), 'app_early_pub_number': FieldInfo(annotation=Union[str, NoneType], required=True, alias='earliestPublicationNumber', alias_priority=2), 'app_filing_date': FieldInfo(annotation=date, required=True, alias='filingDate', alias_priority=2), 'app_type_code': FieldInfo(annotation=str, required=True, alias='applicationTypeCode', alias_priority=2), 'appl_id': FieldInfo(annotation=str, required=True, alias='applicationNumberText', alias_priority=2), 'assignments': FieldInfo(annotation=list[Assignment], required=True, alias='assignmentBag', alias_priority=2), 'attorneys': FieldInfo(annotation=CustomerNumber, required=True, alias='recordAttorney', alias_priority=2), 'atty_docket_num': FieldInfo(annotation=str, required=True, alias='docketNumber', alias_priority=2), 'child_applications': FieldInfo(annotation=Union[list[Relationship], NoneType], required=False, default=None, alias=AliasPath(path=['continuityBag', 'childContinuityBag']), alias_priority=2, serialization_alias='childApplications'), 'cls_sub_cls': FieldInfo(annotation=str, required=True, alias='class/subclass', alias_priority=2), 'correspondence_address': FieldInfo(annotation=list[Address], required=True, alias='correspondenceAddressBag', alias_priority=2), 'cpc_classifications': FieldInfo(annotation=list[str], required=True, alias='cpcClassificationBag', alias_priority=2), 'customer_number': FieldInfo(annotation=int, required=True, alias='customerNumber', alias_priority=2), 'effective_filing_date': FieldInfo(annotation=date, required=True, alias='effectiveFilingDate', alias_priority=2), 'entity_status': FieldInfo(annotation=str, required=True, alias='businessEntityStatusCategory', alias_priority=2), 'first_applicant_name': FieldInfo(annotation=str, required=True, alias='firstApplicantName', alias_priority=2), 'first_inventor_name': FieldInfo(annotation=str, required=True, alias='firstInventorName', alias_priority=2), 'group_art_unit': FieldInfo(annotation=str, required=True, alias='groupArtUnitNumber', alias_priority=2), 'invention_title': FieldInfo(annotation=str, required=True, alias='inventionTitle', alias_priority=2), 'inventors': FieldInfo(annotation=list[Inventor], required=True, alias='inventorBag', alias_priority=2), 'national_stage_indicator': FieldInfo(annotation=bool, required=True, alias='nationalStageIndicator', alias_priority=2, metadata=[BeforeValidator(func=<function <lambda>>)]), 'parent_applications': FieldInfo(annotation=Union[list[Relationship], NoneType], required=False, default=None, alias=AliasPath(path=['continuityBag', 'parentContinuityBag']), alias_priority=2, serialization_alias='parentApplications'), 'patent_term_adjustment': FieldInfo(annotation=Union[TermAdjustment, NoneType], required=True, alias='patentTermAdjustmentData', alias_priority=2), 'transactions': FieldInfo(annotation=list[Transaction], required=True, alias='transactionContentBag', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.SearchResult(*, filingDate: date, applicationNumberText: str, inventionTitle: str, patentNumber: Optional[str] = None)

appl_id: str

invention_title: str

filing_date: date

patent_number: Optional[str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'appl_id': FieldInfo(annotation=str, required=True, alias='applicationNumberText', alias_priority=2), 'filing_date': FieldInfo(annotation=date, required=True, alias='filingDate', alias_priority=2), 'invention_title': FieldInfo(annotation=str, required=True, alias='inventionTitle', alias_priority=2), 'patent_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='patentNumber', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.SearchResponse(*, count: int, patentBag: list[patent_client._sync.uspto.odp.model.SearchResult], requestIdentifier: str)

count: int

results: list[patent_client._sync.uspto.odp.model.SearchResult]

request_id: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'async_property.base.AsyncPropertyDescriptor'>,)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'count': FieldInfo(annotation=int, required=True, alias='count', alias_priority=1), 'request_id': FieldInfo(annotation=str, required=True, alias='requestIdentifier', alias_priority=2), 'results': FieldInfo(annotation=list[SearchResult], required=True, alias='patentBag', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Filter(*, name: str, value: List[str])

name: str

value: List[str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>, <class 'async_property.base.AsyncPropertyDescriptor'>)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'name': FieldInfo(annotation=str, required=True), 'value': FieldInfo(annotation=List[str], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Range(*, field: str, valueFrom: str, valueTo: str)

field: str

valueFrom: str

valueTo: str

classmethod add_default_dates(data: Any) → Any

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>, <class 'async_property.base.AsyncPropertyDescriptor'>)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'field': FieldInfo(annotation=str, required=True, examples=['grantDate']), 'valueFrom': FieldInfo(annotation=str, required=True, examples=['2020-01-01']), 'valueTo': FieldInfo(annotation=str, required=True, examples=['2020-12-31'])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.SortOrder(value)

An enumeration.

asc = 'asc'

desc = 'desc'

Asc = 'Asc'

Desc = 'Desc'

class patent_client._sync.uspto.odp.model.Sort(*, field: str, order: SortOrder)

field: str

order: SortOrder

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>, <class 'async_property.base.AsyncPropertyDescriptor'>)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'field': FieldInfo(annotation=str, required=True, examples=['grantDate']), 'order': FieldInfo(annotation=SortOrder, required=True, examples=[<SortOrder.desc: 'desc'>])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.Pagination(*, offset: int = 0, limit: int = 25)

offset: int

limit: int

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>, <class 'async_property.base.AsyncPropertyDescriptor'>)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'limit': FieldInfo(annotation=int, required=False, default=25, examples=[25], metadata=[Ge(ge=1)]), 'offset': FieldInfo(annotation=int, required=False, default=0, examples=[0], metadata=[Ge(ge=0)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.SearchRequest(*, q: str = '', filters: Optional[List[Filter]] = None, rangeFilters: Optional[List[Range]] = None, sort: Optional[List[Sort]] = None, fields: Optional[List[str]] = None, pagination: Optional[Pagination] = None, facets: Optional[List[str]] = None)

q: str

filters: Optional[List[Filter]]

rangeFilters: Optional[List[Range]]

sort: Optional[List[Sort]]

fields: Optional[List[str]]

pagination: Optional[Pagination]

facets: Optional[List[str]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>, <class 'async_property.base.AsyncPropertyDescriptor'>)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'facets': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None), 'fields': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None), 'filters': FieldInfo(annotation=Union[List[Filter], NoneType], required=False, default=None), 'pagination': FieldInfo(annotation=Union[Pagination, NoneType], required=False, default=None), 'q': FieldInfo(annotation=str, required=False, default=''), 'rangeFilters': FieldInfo(annotation=Union[List[Range], NoneType], required=False, default=None), 'sort': FieldInfo(annotation=Union[List[Sort], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client._sync.uspto.odp.model.SearchGetRequest(*, q: str = '', sort: str = 'filingDate', fields: str = '', offset: int = 0, limit: int = 25)

q: str

sort: str

fields: str

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>, <class 'async_property.base.AsyncPropertyDescriptor'>)}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'fields': FieldInfo(annotation=str, required=False, default=''), 'limit': FieldInfo(annotation=int, required=False, default=25), 'offset': FieldInfo(annotation=int, required=False, default=0), 'q': FieldInfo(annotation=str, required=False, default=''), 'sort': FieldInfo(annotation=str, required=False, default='filingDate')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

offset: int

limit: int

Asynchronous

Manager

Models