INPADOC Published Data#
Manager#
Models#
- class patent_client.epo.ops.published.model.BiblioResult(*, documents: list[patent_client.epo.ops.published.model.biblio.InpadocBiblio] = None)[source]#
-
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'documents': FieldInfo(annotation=list[InpadocBiblio], 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.epo.ops.published.model.InpadocBiblio(*, country: Optional[str] = None, doc_number: Optional[str] = None, kind: Optional[str] = None, family_id: Optional[str] = None, publication_number: Optional[str] = None, application_number: Optional[str] = None, publication_reference_docdb: Optional[DocumentId] = None, publication_reference_epodoc: Optional[DocumentId] = None, publication_reference_original: Optional[DocumentId] = None, application_reference_docdb: Optional[DocumentId] = None, application_reference_epodoc: Optional[DocumentId] = None, application_reference_original: Optional[DocumentId] = None, intl_class: List[str] = None, cpc_class: List[str] = None, us_class: List[str] = None, priority_claims: List[DocumentId] = None, title: Optional[str] = None, titles: List[Title] = None, abstract: Optional[str] = None, citations: List[Citation] = None, applicants_epodoc: List[str] = None, applicants_original: List[str] = None, inventors_epodoc: List[str] = None, inventors_original: List[str] = None)[source]#
-
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'abstract': FieldInfo(annotation=Union[str, NoneType], required=False), 'applicants_epodoc': FieldInfo(annotation=List[str], required=False, default_factory=list), 'applicants_original': FieldInfo(annotation=List[str], required=False, default_factory=list), 'application_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'application_reference_docdb': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'application_reference_epodoc': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'application_reference_original': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'citations': FieldInfo(annotation=List[Citation], required=False, default_factory=list), 'country': FieldInfo(annotation=Union[str, NoneType], required=False), 'cpc_class': FieldInfo(annotation=List[str], required=False, default_factory=list), 'doc_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'family_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'intl_class': FieldInfo(annotation=List[str], required=False, default_factory=list), 'inventors_epodoc': FieldInfo(annotation=List[str], required=False, default_factory=list), 'inventors_original': FieldInfo(annotation=List[str], required=False, default_factory=list), 'kind': FieldInfo(annotation=Union[str, NoneType], required=False), 'priority_claims': FieldInfo(annotation=List[DocumentId], required=False, default_factory=list), 'publication_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'publication_reference_docdb': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'publication_reference_epodoc': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'publication_reference_original': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'title': FieldInfo(annotation=Union[str, NoneType], required=False), 'titles': FieldInfo(annotation=List[Title], required=False, default_factory=list), 'us_class': FieldInfo(annotation=List[str], 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.epo.ops.published.model.Claims(*, document_id: Optional[FTDocumentId] = None, claims: List[Claim] = None, claim_text: Optional[str] = None)[source]#
-
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'claim_text': FieldInfo(annotation=Union[str, NoneType], required=False), 'claims': FieldInfo(annotation=List[Claim], required=False, default_factory=list), 'document_id': FieldInfo(annotation=Union[FTDocumentId, NoneType], required=False)}#
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.epo.ops.published.model.Description(*, document_id: Optional[FTDocumentId] = None, description: Optional[str] = None)[source]#
-
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False), 'document_id': FieldInfo(annotation=Union[FTDocumentId, NoneType], required=False)}#
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.epo.ops.published.model.Images(*, publication_number: Optional[str] = None, full_document: Optional[ImageDocument] = None, drawing: Optional[ImageDocument] = None, first_page: Optional[ImageDocument] = None)[source]#
-
- full_document: Optional[ImageDocument]#
- drawing: Optional[ImageDocument]#
- first_page: Optional[ImageDocument]#
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'drawing': FieldInfo(annotation=Union[ImageDocument, NoneType], required=False), 'first_page': FieldInfo(annotation=Union[ImageDocument, NoneType], required=False), 'full_document': FieldInfo(annotation=Union[ImageDocument, NoneType], required=False), 'publication_number': FieldInfo(annotation=Union[str, NoneType], required=False)}#
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.epo.ops.published.model.ImageDocument(*, num_pages: Optional[int] = None, description: Optional[str] = None, link: Optional[str] = None, formats: List[str] = None, sections: List[Section] = None, doc_number: Optional[str] = None)[source]#
-
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False), 'doc_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'formats': FieldInfo(annotation=List[str], required=False, default_factory=list), 'link': FieldInfo(annotation=Union[str, NoneType], required=False), 'num_pages': FieldInfo(annotation=Union[int, NoneType], required=False), 'sections': FieldInfo(annotation=List[Section], 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.
INPADOC Legal Data#
Manager#
- class patent_client.epo.ops.legal.manager.LegalManager(config=None)[source]#
- async aget(doc_number, doc_type='publication', format='docdb') ListCollection[LegalEvent] [source]#
If the critera results in a single record, return it, else raise an exception
Models#
- class patent_client.epo.ops.legal.model.MetaData(*, status_of_data: Optional[str] = None, docdb_publication_number: Optional[str] = None, subscriber_exchange_date: Optional[date] = None, epo_created_date: Optional[date] = None, docdb_integer: Optional[int] = None)[source]#
-
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'docdb_integer': FieldInfo(annotation=Union[int, NoneType], required=False), 'docdb_publication_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'epo_created_date': FieldInfo(annotation=Union[Annotated[date, BeforeValidator], NoneType], required=False), 'status_of_data': FieldInfo(annotation=Union[str, NoneType], required=False), 'subscriber_exchange_date': FieldInfo(annotation=Union[Annotated[date, BeforeValidator], NoneType], required=False)}#
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.epo.ops.legal.model.LegalEvent(*, filing_or_publication: Optional[str] = None, document_number: Optional[str] = None, ip_type: Optional[str] = None, metadata: Optional[MetaData] = None, country_code: Optional[str] = None, text_record: Optional[str] = None, event_date: Optional[date] = None, event_code: Optional[str] = None, event_country: Optional[str] = None, event_description: Optional[str] = None, regional_event_code: Optional[str] = None, corresponding_patent: Optional[str] = None, corresponding_patent_publication_date: Optional[date] = None, designated_states: Optional[str] = None, extension_name: Optional[str] = None, new_owner_name: Optional[str] = None, free_text: Optional[str] = None, spc_number: Optional[str] = None, spc_filing_date: Optional[str] = None, expiry: Optional[str] = None, publication_language: Optional[str] = None, inventor_name: Optional[str] = None, ipc_class: Optional[str] = None, representative_name: Optional[str] = None, payment_date: Optional[str] = None, opponent_name: Optional[str] = None, year_of_fee_payment: Optional[str] = None, name_of_requester: Optional[str] = None, date_extension_granted: Optional[str] = None, extension_states: Optional[str] = None, effective_date: Optional[date] = None, date_of_withdrawal: Optional[str] = None)[source]#
Field descriptions are here: https://documents.epo.org/projects/babylon/eponot.nsf/0/EF223017D933B30AC1257B50005A042E/$File/14.11_User_Documentation_3.1_en.pdf
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'corresponding_patent': FieldInfo(annotation=Union[str, NoneType], required=False), 'corresponding_patent_publication_date': FieldInfo(annotation=Union[Annotated[date, BeforeValidator], NoneType], required=False), 'country_code': FieldInfo(annotation=Union[str, NoneType], required=False), 'date_extension_granted': FieldInfo(annotation=Union[str, NoneType], required=False), 'date_of_withdrawal': FieldInfo(annotation=Union[str, NoneType], required=False), 'designated_states': FieldInfo(annotation=Union[str, NoneType], required=False), 'document_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'effective_date': FieldInfo(annotation=Union[Annotated[date, BeforeValidator], NoneType], required=False), 'event_code': FieldInfo(annotation=Union[str, NoneType], required=False), 'event_country': FieldInfo(annotation=Union[str, NoneType], required=False), 'event_date': FieldInfo(annotation=Union[Annotated[date, BeforeValidator], NoneType], required=False), 'event_description': FieldInfo(annotation=Union[str, NoneType], required=False), 'expiry': FieldInfo(annotation=Union[str, NoneType], required=False), 'extension_name': FieldInfo(annotation=Union[str, NoneType], required=False), 'extension_states': FieldInfo(annotation=Union[str, NoneType], required=False), 'filing_or_publication': FieldInfo(annotation=Union[str, NoneType], required=False), 'free_text': FieldInfo(annotation=Union[str, NoneType], required=False), 'inventor_name': FieldInfo(annotation=Union[str, NoneType], required=False), 'ip_type': FieldInfo(annotation=Union[str, NoneType], required=False), 'ipc_class': FieldInfo(annotation=Union[str, NoneType], required=False), 'metadata': FieldInfo(annotation=Union[MetaData, NoneType], required=False), 'name_of_requester': FieldInfo(annotation=Union[str, NoneType], required=False), 'new_owner_name': FieldInfo(annotation=Union[str, NoneType], required=False), 'opponent_name': FieldInfo(annotation=Union[str, NoneType], required=False), 'payment_date': FieldInfo(annotation=Union[str, NoneType], required=False), 'publication_language': FieldInfo(annotation=Union[str, NoneType], required=False), 'regional_event_code': FieldInfo(annotation=Union[str, NoneType], required=False), 'representative_name': FieldInfo(annotation=Union[str, NoneType], required=False), 'spc_filing_date': FieldInfo(annotation=Union[str, NoneType], required=False), 'spc_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'text_record': FieldInfo(annotation=Union[str, NoneType], required=False), 'year_of_fee_payment': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
INPADOC Family Data#
Manager#
Models#
- class patent_client.epo.ops.family.model.PriorityClaim(*, application_number: Optional[str] = None, application_reference: Optional[DocumentId] = None, sequence: Optional[int] = None, kind: Optional[str] = None, active: Optional[bool] = None)[source]#
-
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'active': FieldInfo(annotation=Union[bool, NoneType], required=False), 'application_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'application_reference': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'kind': FieldInfo(annotation=Union[str, NoneType], required=False), 'sequence': FieldInfo(annotation=Union[int, NoneType], required=False)}#
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.epo.ops.family.model.FamilyMember(*, publication_number: Optional[str] = None, application_number: Optional[str] = None, family_id: Optional[str] = None, publication_reference: list = None, application_reference: list = None, priority_claims: List[PriorityClaim] = None)[source]#
-
- priority_claims: List[PriorityClaim]#
- property docdb_number#
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'application_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'application_reference': FieldInfo(annotation=list, required=False, default_factory=list), 'family_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'priority_claims': FieldInfo(annotation=List[PriorityClaim], required=False, default_factory=list), 'publication_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'publication_reference': FieldInfo(annotation=list, 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.epo.ops.family.model.Family(*, publication_reference: Optional[DocumentId] = None, num_records: Optional[int] = None, publication_number: Optional[str] = None, family_members: List[FamilyMember] = None)[source]#
-
- family_members: List[FamilyMember]#
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'family_members': FieldInfo(annotation=List[FamilyMember], required=False, default_factory=list), 'num_records': FieldInfo(annotation=Union[int, NoneType], required=False), 'publication_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'publication_reference': FieldInfo(annotation=Union[DocumentId, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.