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: Optional[int] = None, claimParentageTypeCode: Optional[str] = None, filingDate: Optional[date] = None, applicationStatusDescriptionText: Optional[str] = None, claimParentageTypeCodeDescription: Optional[str] = None, parentApplicationNumberText: Optional[str] = None, childApplicationNumberText: Optional[str] = None)

application_status_code: Optional[int]

claim_type_code: Optional[str]

filing_date: Optional[date]

application_status_description: Optional[str]

claim_type_description: Optional[str]

parent_application_id: Optional[str]

child_application_id: 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]] = {'application_status_code': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='applicationStatusCode', alias_priority=1), 'application_status_description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='applicationStatusDescriptionText', alias_priority=2), 'child_application_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='childApplicationNumberText', alias_priority=2), 'claim_type_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='claimParentageTypeCode', alias_priority=2), 'claim_type_description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='claimParentageTypeCodeDescription', alias_priority=2), 'filing_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='filingDate', alias_priority=1), 'parent_application_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[int] = None, requestIdentifier: Optional[str] = None, 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: Optional[int]

request_identifier: Optional[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_factory=list, alias=AliasPath(path=[['patentBag', 0, 'continuityBag', 'childContinuityBag']]), alias_priority=2, serialization_alias='childContinuity'), 'count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='count', alias_priority=1), 'parent_continuity': FieldInfo(annotation=Union[list[Relationship], NoneType], required=False, default_factory=list, alias=AliasPath(path=[['patentBag', 0, 'continuityBag', 'parentContinuityBag']]), alias_priority=2, serialization_alias='parentContinuity'), 'request_identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[str] = None, downloadUrl: Optional[str] = None, pageTotalQuantity: Optional[int] = None)

mime_type_identifier: Optional[str]

download_url: Optional[str]

pages: Optional[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=Union[str, NoneType], required=False, default=None, alias='downloadUrl', alias_priority=1), 'mime_type_identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='mimeTypeIdentifier', alias_priority=1), 'pages': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, 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: Optional[str] = None, officialDate: Optional[datetime] = None, documentIdentifier: Optional[str] = None, documentCode: Optional[str] = None, documentCodeDescriptionText: Optional[str] = None, directionCategory: Optional[str] = None, downloadOptionBag: list[dict] = None)

appl_id: Optional[str]

mail_date: Optional[datetime]

document_identifier: Optional[str]

document_code: Optional[str]

document_code_description: Optional[str]

direction_category: Optional[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=Union[str, NoneType], required=False, default=None, alias='applicationNumberText', alias_priority=2), 'direction_category': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='directionCategory', alias_priority=2), 'document_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='documentCode', alias_priority=2), 'document_code_description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='documentCodeDescriptionText', alias_priority=2), 'document_identifier': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='documentIdentifier', alias_priority=2), 'download_option_bag': FieldInfo(annotation=list[dict], required=False, default_factory=list, alias='downloadOptionBag', alias_priority=2), 'mail_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None, 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: Optional[date] = None, assignorName: Optional[str] = None)

execution_date: Optional[date]

assignor_name: 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]] = {'assignor_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='assignorName', alias_priority=2), 'execution_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, 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: Optional[str] = None, geographicRegionCode: Optional[str] = None, postalCode: Optional[str] = None, addressLineOneText: Optional[str] = None)

city_name: Optional[str]

geographic_region_code: Optional[str]

postal_code: Optional[str]

address_line_one_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), 'city_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='cityName', alias_priority=2), 'geographic_region_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='geographicRegionCode', 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.Assignee(*, assigneeAddress: Optional[AssigneeAddress] = None, assigneeNameText: Optional[str] = None)

assignee_address: Optional[AssigneeAddress]

assignee_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]] = {'assignee_address': FieldInfo(annotation=Union[AssigneeAddress, NoneType], required=False, default=None, alias='assigneeAddress', alias_priority=2), 'assignee_name_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[date] = None, frameNumber: Optional[str] = None, pageNumber: Optional[int] = None, reel_number_frame_number: Optional[str] = None, assignmentRecordedDate: Optional[date] = None, conveyanceText: Optional[str] = None, assignmentMailedDate: Optional[date] = None, reelNumber: Optional[str] = None, assignorBag: list[patent_client._sync.uspto.odp.model.Assignor] = None, assigneeBag: list[patent_client._sync.uspto.odp.model.Assignee] = None, correspondenceAddress: list[patent_client._sync.uspto.odp.model.Address] = None)

assignment_received_date: Optional[date]

frame_number: Optional[str]

page_number: Optional[int]

reel_number_frame_number: Optional[str]

assignment_recorded_date: Optional[date]

conveyance_text: Optional[str]

assignment_mailed_date: Optional[date]

reel_number: Optional[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=False, default_factory=list, alias='assigneeBag', alias_priority=2), 'assignment_mailed_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='assignmentMailedDate', alias_priority=2), 'assignment_received_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='assignmentReceivedDate', alias_priority=2), 'assignment_recorded_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='assignmentRecordedDate', alias_priority=2), 'assignor_bag': FieldInfo(annotation=list[Assignor], required=False, default_factory=list, alias='assignorBag', alias_priority=2), 'conveyance_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='conveyanceText', alias_priority=2), 'correspondence_address': FieldInfo(annotation=list[Address], required=False, default_factory=list, alias='correspondenceAddress', alias_priority=2), 'frame_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='frameNumber', alias_priority=2), 'page_number': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='pageNumber', alias_priority=2), 'reel_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='reelNumber', alias_priority=2), 'reel_number_frame_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[str] = None, filingDate: Optional[date] = None, countryName: Optional[str] = None)

priority_number_text: Optional[str]

filing_date: Optional[date]

country_name: 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]] = {'country_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='countryName', alias_priority=2), 'filing_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='filingDate', alias_priority=2), 'priority_number_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[str] = None, usageTypeCategory: Optional[str] = None)

telecommunication_number: Optional[str]

usage_type_category: 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]] = {'telecommunication_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='telecommunicationNumber', alias_priority=2), 'usage_type_category': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[str] = None, firstName: Optional[str] = None, lastName: Optional[str] = None, registrationNumber: Optional[str] = None, attorneyAddressBag: list[patent_client._sync.uspto.odp.model.Address] = None, telecommunicationAddressBag: list[patent_client._sync.uspto.odp.model.TelecommunicationAddress] = None, registeredPractitionerCategory: Optional[str] = None, nameSuffix: Optional[str] = None)

active_indicator: Optional[str]

first_name: Optional[str]

last_name: Optional[str]

registration_number: Optional[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: Optional[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=Union[str, NoneType], required=False, default=None, alias='activeIndicator', alias_priority=2), 'attorney_address_bag': FieldInfo(annotation=list[Address], required=False, default_factory=list, 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=Union[str, NoneType], required=False, default=None, alias='registeredPractitionerCategory', alias_priority=2), 'registration_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='registrationNumber', alias_priority=2), 'telecommunication_address_bag': FieldInfo(annotation=list[TelecommunicationAddress], required=False, default_factory=list, 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] = None, customer_number: Optional[str] = None, address: Optional[Address] = None)

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=False, default=None, alias=AliasPath(path=['customerNumber', 'powerOfAttorneyAddressBag', 0]), alias_priority=2, serialization_alias='address'), 'attorneys': FieldInfo(annotation=list[Attorney], required=False, default_factory=list, alias='attorneyBag', alias_priority=2), 'customer_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[date] = None, caseActionCode: Optional[str] = None, caseActionDescriptionText: Optional[str] = None)

recorded_date: Optional[date]

transaction_code: Optional[str]

transaction_description: 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]] = {'recorded_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='recordedDate', alias_priority=2), 'transaction_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='caseActionCode', alias_priority=2), 'transaction_description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[int] = None, startSequenceNumber: Optional[float] = None, caseActionDescriptionText: Optional[str] = None, caseActionSequenceNumber: Optional[float] = None, actionDate: Optional[date] = None)

applicant_day_delay_quantity: Optional[int]

start_sequence_number: Optional[float]

case_action_description_text: Optional[str]

case_action_sequence_number: Optional[float]

action_date: Optional[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=Union[date, NoneType], required=False, default=None, alias='actionDate', alias_priority=2), 'applicant_day_delay_quantity': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='applicantDayDelayQuantity', alias_priority=2), 'case_action_description_text': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='caseActionDescriptionText', alias_priority=2), 'case_action_sequence_number': FieldInfo(annotation=Union[float, NoneType], required=False, default=None, alias='caseActionSequenceNumber', alias_priority=2), 'start_sequence_number': FieldInfo(annotation=Union[float, NoneType], required=False, default=None, 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_factory=list, 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: Optional[str] = None, lastName: Optional[str] = None, inventorNameText: Optional[str] = None, correspondenceAddressBag: list[patent_client._sync.uspto.odp.model.Address] = None)

first_name: Optional[str]

last_name: Optional[str]

full_name: Optional[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=False, default_factory=list, alias='correspondenceAddressBag', alias_priority=2), 'first_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='firstName', alias_priority=2), 'full_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='inventorNameText', alias_priority=2), 'last_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[str] = None, correspondenceAddressBag: list[patent_client._sync.uspto.odp.model.Address] = None, applicationStatusCode: Optional[int] = None, applicationStatusDescriptionText: Optional[str] = None)

applicant_name: Optional[str]

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

app_status_code: Optional[int]

app_status: 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]] = {'addresses': FieldInfo(annotation=list[Address], required=False, default_factory=list, alias='correspondenceAddressBag', alias_priority=2), 'app_status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='applicationStatusDescriptionText', alias_priority=2), 'app_status_code': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='applicationStatusCode', alias_priority=2), 'applicant_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: ~typing.Optional[bool] = None, filingDate: ~typing.Optional[~datetime.date] = None, inventorBag: list[patent_client._sync.uspto.odp.model.Inventor] = None, customerNumber: ~typing.Optional[int] = <property object>, groupArtUnitNumber: ~typing.Optional[str] = None, inventionTitle: ~typing.Optional[str] = None, correspondenceAddressBag: list[patent_client._sync.uspto.odp.model.Address] = None, applicationConfirmationNumber: ~typing.Optional[int] = None, docketNumber: ~typing.Optional[str] = None, applicationNumberText: ~typing.Optional[str] = None, firstInventorName: ~typing.Optional[str] = None, firstApplicantName: ~typing.Optional[str] = None, cpcClassificationBag: list[str] = None, businessEntityStatusCategory: ~typing.Optional[str] = None, earliestPublicationNumber: ~typing.Optional[str] = None, earliestPublicationDate: ~typing.Optional[~datetime.date] = None, patentNumber: ~typing.Optional[str] = None, grantDate: ~typing.Optional[~datetime.date] = None, applicationStatusDescriptionText: ~typing.Optional[str] = None, applicationStatusDate: ~typing.Optional[~datetime.date] = None, applicationStatusCode: ~typing.Optional[int] = None)

aia_indicator: Optional[bool]

app_filing_date: Optional[date]

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

group_art_unit: Optional[str]

invention_title: Optional[str]

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

app_conf_num: Optional[int]

atty_docket_num: Optional[str]

appl_id: Optional[str]

first_inventor_name: Optional[str]

first_applicant_name: Optional[str]

cpc_classifications: list[str]

entity_status: Optional[str]

app_early_pub_number: Optional[str]

app_early_pub_date: Optional[date]

patent_number: Optional[str]

grant_date: Optional[date]

status: Optional[str]

status_date: Optional[date]

status_code: Optional[int]

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: Optional[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=Union[Annotated[bool, BeforeValidator], NoneType], required=False, default=None, alias='firstInventorToFileIndicator', alias_priority=2), 'app_conf_num': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='applicationConfirmationNumber', alias_priority=2), 'app_early_pub_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='earliestPublicationDate', alias_priority=2), 'app_early_pub_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='earliestPublicationNumber', alias_priority=2), 'app_filing_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='filingDate', alias_priority=2), 'appl_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='applicationNumberText', alias_priority=2), 'atty_docket_num': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='docketNumber', alias_priority=2), 'correspondence_address': FieldInfo(annotation=list[Address], required=False, default_factory=list, alias='correspondenceAddressBag', alias_priority=2), 'cpc_classifications': FieldInfo(annotation=list[str], required=False, default_factory=list, alias='cpcClassificationBag', alias_priority=2), 'customer_number': FieldInfo(annotation=Union[int, NoneType], required=False, default=<property object>, alias='customerNumber', alias_priority=1), 'entity_status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='businessEntityStatusCategory', alias_priority=2), 'first_applicant_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='firstApplicantName', alias_priority=2), 'first_inventor_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='firstInventorName', alias_priority=2), 'grant_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='grantDate', alias_priority=2), 'group_art_unit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='groupArtUnitNumber', alias_priority=2), 'invention_title': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='inventionTitle', alias_priority=2), 'inventors': FieldInfo(annotation=list[Inventor], required=False, default_factory=list, alias='inventorBag', alias_priority=2), 'patent_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='patentNumber', alias_priority=2), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='applicationStatusDescriptionText', alias_priority=2), 'status_code': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='applicationStatusCode', alias_priority=2), 'status_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='applicationStatusDate', 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: Optional[bool] = None, filingDate: Optional[date] = None, inventorBag: list[patent_client._sync.uspto.odp.model.Inventor] = None, customerNumber: Optional[int] = None, groupArtUnitNumber: Optional[str] = None, inventionTitle: Optional[str] = None, correspondenceAddressBag: list[patent_client._sync.uspto.odp.model.Address] = None, applicationConfirmationNumber: Optional[int] = None, docketNumber: Optional[str] = None, applicationNumberText: Optional[str] = None, firstInventorName: Optional[str] = None, firstApplicantName: Optional[str] = None, cpcClassificationBag: list[str] = None, businessEntityStatusCategory: Optional[str] = None, earliestPublicationNumber: Optional[str] = None, earliestPublicationDate: Optional[date] = None, patentNumber: Optional[str] = None, grantDate: Optional[date] = None, applicationTypeCode: Optional[str] = None, nationalStageIndicator: Optional[bool] = None, applicationStatusDescriptionText: Optional[str] = None, applicationStatusDate: Optional[date] = None, applicationStatusCode: Optional[int] = None, effectiveFilingDate: Optional[date] = None, cls_sub_cls: Optional[str] = None, assignmentBag: list[patent_client._sync.uspto.odp.model.Assignment] = None, recordAttorney: Optional[CustomerNumber] = None, transactionContentBag: list[patent_client._sync.uspto.odp.model.Transaction] = None, 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] = None)

aia_indicator: Optional[bool]

app_filing_date: Optional[date]

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

customer_number: Optional[int]

group_art_unit: Optional[str]

invention_title: Optional[str]

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

app_conf_num: Optional[int]

atty_docket_num: Optional[str]

appl_id: Optional[str]

first_inventor_name: Optional[str]

first_applicant_name: Optional[str]

cpc_classifications: list[str]

entity_status: Optional[str]

app_early_pub_number: Optional[str]

app_early_pub_date: Optional[date]

patent_number: Optional[str]

grant_date: Optional[date]

app_type_code: Optional[str]

national_stage_indicator: Optional[bool]

status: Optional[str]

status_date: Optional[date]

status_code: Optional[int]

effective_filing_date: Optional[date]

cls_sub_cls: Optional[str]

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

attorneys: Optional[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=Union[Annotated[bool, BeforeValidator], NoneType], required=False, default=None, alias='firstInventorToFileIndicator', alias_priority=2), 'app_conf_num': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='applicationConfirmationNumber', alias_priority=2), 'app_early_pub_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='earliestPublicationDate', alias_priority=2), 'app_early_pub_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='earliestPublicationNumber', alias_priority=2), 'app_filing_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='filingDate', alias_priority=2), 'app_type_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='applicationTypeCode', alias_priority=2), 'appl_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='applicationNumberText', alias_priority=2), 'assignments': FieldInfo(annotation=list[Assignment], required=False, default_factory=list, alias='assignmentBag', alias_priority=2), 'attorneys': FieldInfo(annotation=Union[CustomerNumber, NoneType], required=False, default=None, alias='recordAttorney', alias_priority=2), 'atty_docket_num': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='docketNumber', alias_priority=2), 'child_applications': FieldInfo(annotation=Union[list[Relationship], NoneType], required=False, default_factory=list, alias=AliasPath(path=['continuityBag', 'childContinuityBag']), alias_priority=2, serialization_alias='childApplications'), 'cls_sub_cls': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='class/subclass', alias_priority=2), 'correspondence_address': FieldInfo(annotation=list[Address], required=False, default_factory=list, alias='correspondenceAddressBag', alias_priority=2), 'cpc_classifications': FieldInfo(annotation=list[str], required=False, default_factory=list, alias='cpcClassificationBag', alias_priority=2), 'customer_number': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='customerNumber', alias_priority=2), 'effective_filing_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='effectiveFilingDate', alias_priority=2), 'entity_status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='businessEntityStatusCategory', alias_priority=2), 'first_applicant_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='firstApplicantName', alias_priority=2), 'first_inventor_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='firstInventorName', alias_priority=2), 'grant_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='grantDate', alias_priority=2), 'group_art_unit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='groupArtUnitNumber', alias_priority=2), 'invention_title': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='inventionTitle', alias_priority=2), 'inventors': FieldInfo(annotation=list[Inventor], required=False, default_factory=list, alias='inventorBag', alias_priority=2), 'national_stage_indicator': FieldInfo(annotation=Union[Annotated[bool, BeforeValidator], NoneType], required=False, default=None, alias='nationalStageIndicator', alias_priority=2), 'parent_applications': FieldInfo(annotation=Union[list[Relationship], NoneType], required=False, default_factory=list, alias=AliasPath(path=['continuityBag', 'parentContinuityBag']), alias_priority=2, serialization_alias='parentApplications'), 'patent_number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='patentNumber', alias_priority=2), 'patent_term_adjustment': FieldInfo(annotation=Union[TermAdjustment, NoneType], required=False, default=None, alias='patentTermAdjustmentData', alias_priority=2), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='applicationStatusDescriptionText', alias_priority=2), 'status_code': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='applicationStatusCode', alias_priority=2), 'status_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='applicationStatusDate', alias_priority=2), 'transactions': FieldInfo(annotation=list[Transaction], required=False, default_factory=list, 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: Optional[date] = None, applicationNumberText: Optional[str] = None, inventionTitle: Optional[str] = None, patentNumber: Optional[str] = None)

appl_id: Optional[str]

invention_title: Optional[str]

filing_date: Optional[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=Union[str, NoneType], required=False, default=None, alias='applicationNumberText', alias_priority=2), 'filing_date': FieldInfo(annotation=Union[date, NoneType], required=False, default=None, alias='filingDate', alias_priority=1), 'invention_title': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[int] = None, patentBag: list[patent_client._sync.uspto.odp.model.SearchResult] = None, requestIdentifier: Optional[str] = None)

count: Optional[int]

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

request_id: 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]] = {'count': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='count', alias_priority=1), 'request_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='requestIdentifier', alias_priority=2), 'results': FieldInfo(annotation=list[SearchResult], required=False, default_factory=list, 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: Optional[str] = None, value: Optional[List[str]] = None)

name: Optional[str]

value: 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]] = {'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'value': FieldInfo(annotation=Union[List[str], NoneType], required=False, default_factory=list)}

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: Optional[str] = None, valueFrom: Optional[str] = None, valueTo: Optional[str] = None)

field: Optional[str]

valueFrom: Optional[str]

valueTo: Optional[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=Union[str, NoneType], required=False, default=None, examples=['grantDate']), 'valueFrom': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, examples=['2020-01-01']), 'valueTo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, 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: Optional[str] = None, order: Optional[SortOrder] = None)

field: Optional[str]

order: Optional[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=Union[str, NoneType], required=False, default=None, examples=['grantDate']), 'order': FieldInfo(annotation=Union[SortOrder, NoneType], required=False, default=None, 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: Optional[int] = 0, limit: Optional[int] = 25)

offset: Optional[int]

limit: Optional[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=Union[int, NoneType], required=False, default=25, examples=[25], metadata=[Ge(ge=1)]), 'offset': FieldInfo(annotation=Union[int, NoneType], 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: Optional[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: Optional[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_factory=list), 'fields': FieldInfo(annotation=Union[List[str], NoneType], required=False, default_factory=list), 'filters': FieldInfo(annotation=Union[List[Filter], NoneType], required=False, default_factory=list), 'pagination': FieldInfo(annotation=Union[Pagination, NoneType], required=False, default=None), 'q': FieldInfo(annotation=Union[str, NoneType], required=False, default=''), 'rangeFilters': FieldInfo(annotation=Union[List[Range], NoneType], required=False, default_factory=list), 'sort': FieldInfo(annotation=Union[List[Sort], NoneType], required=False, default_factory=list)}

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: Optional[str] = '', sort: Optional[str] = 'filingDate', fields: Optional[str] = '', offset: Optional[int] = 0, limit: Optional[int] = 25)

q: Optional[str]

sort: Optional[str]

fields: Optional[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=Union[str, NoneType], required=False, default=''), 'limit': FieldInfo(annotation=Union[int, NoneType], required=False, default=25), 'offset': FieldInfo(annotation=Union[int, NoneType], required=False, default=0), 'q': FieldInfo(annotation=Union[str, NoneType], required=False, default=''), 'sort': FieldInfo(annotation=Union[str, NoneType], 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: Optional[int]

limit: Optional[int]

Asynchronous

Manager

Models