PTAB

models.ptab - Data models for USPTO PTAB (Patent Trial and Appeal Board) APIs.

This module provides data models, primarily using frozen dataclasses, for representing responses from the USPTO PTAB APIs. These models cover: - Patent trial proceedings (IPR, PGR, CBM, DER) - Trial documents and decisions - Appeal decisions - Interference decisions

class pyUSPTO.models.ptab.AdditionalPartyData(application_number_text=None, inventor_name=None, patent_number=None, additional_party_name=None)

Bases: object

Additional party information in an interference.

application_number_text

Application number.

inventor_name

Name of inventor.

patent_number

Patent number.

additional_party_name

Name of additional party.

additional_party_name: str | None = None

application_number_text: str | None = None

classmethod from_dict(data, include_raw_data=False)

Create an AdditionalPartyData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing additional party data from API response.

• include_raw_data (bool) – Ignored for this model.

Returns:

An instance of AdditionalPartyData.

Return type:

AdditionalPartyData

inventor_name: str | None = None

patent_number: str | None = None

to_dict()

Convert the AdditionalPartyData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.AppealDocumentData(document_filing_date=None, document_identifier=None, document_name=None, document_size_quantity=None, document_ocr_text=None, document_type_description_text=None, file_download_uri=None)

Bases: object

Appeal document metadata.

document_filing_date

Date the document was filed.

document_identifier

Unique identifier for the document.

document_name

Name of the document.

document_size_quantity

Size of the document in bytes.

document_ocr_text

Full OCR text of the document.

document_type_description_text

Description of the document type.

file_download_uri

URI to download the document.

document_filing_date: date | None = None

document_identifier: str | None = None

document_name: str | None = None

document_ocr_text: str | None = None

document_size_quantity: int | None = None

document_type_description_text: str | None = None

file_download_uri: str | None = None

classmethod from_dict(data, include_raw_data=False)

Create an AppealDocumentData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing document data from API response.

• include_raw_data (bool) – Ignored for this model.

Returns:

An instance of AppealDocumentData.

Return type:

AppealDocumentData

to_dict()

Convert the AppealDocumentData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.AppealMetaData(appeal_filing_date=None, appeal_last_modified_date=None, appeal_last_modified_date_time=None, application_type_category=None, docket_notice_mailed_date=None, file_download_uri=None)

Bases: object

Appeal metadata.

appeal_filing_date

Date the appeal was filed.

appeal_last_modified_date

Last modification date.

appeal_last_modified_date_time

Last modification timestamp.

application_type_category

Type of application.

docket_notice_mailed_date

Date the docket notice was mailed.

file_download_uri

URI to download ZIP of appeal documents.

appeal_filing_date: date | None = None

appeal_last_modified_date: date | None = None

appeal_last_modified_date_time: datetime | None = None

application_type_category: str | None = None

docket_notice_mailed_date: date | None = None

file_download_uri: str | None = None

classmethod from_dict(data, include_raw_data=False)

Create an AppealMetaData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing appeal metadata from API response.

• include_raw_data (bool) – Ignored for this model.

Returns:

An instance of AppealMetaData.

Return type:

AppealMetaData

to_dict()

Convert the AppealMetaData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.AppellantData(application_number_text=None, counsel_name=None, grant_date=None, group_art_unit_number=None, inventor_name=None, real_party_in_interest_name=None, patent_number=None, patent_owner_name=None, technology_center_number=None, publication_date=None, publication_number=None)

Bases: PartyData

Appellant party data in PTAB appeals.

Inherits all attributes from PartyData. Used in appeal proceedings to represent the party appealing an examiner decision.

class pyUSPTO.models.ptab.DecisionData(appeal_outcome_category=None, statute_and_rule_bag=<factory>, decision_issue_date=None, decision_type_category=None, issue_type_bag=<factory>)

Bases: object

Appeal decision information.

appeal_outcome_category

Outcome of the appeal.

statute_and_rule_bag

List of applicable statutes and rules.

decision_issue_date

Date the decision was issued.

decision_type_category

Type of decision.

issue_type_bag

List of issue types.

appeal_outcome_category: str | None = None

decision_issue_date: date | None = None

decision_type_category: str | None = None

classmethod from_dict(data, include_raw_data=False)

Create a DecisionData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing decision data from API response.

• include_raw_data (bool) – Ignored for this model.

Returns:

An instance of DecisionData.

Return type:

DecisionData

issue_type_bag: list[str]

statute_and_rule_bag: list[str]

to_dict()

Convert the DecisionData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.DerivationPetitionerData(application_number_text=None, counsel_name=None, grant_date=None, group_art_unit_number=None, inventor_name=None, real_party_in_interest_name=None, patent_number=None, patent_owner_name=None, technology_center_number=None, publication_date=None, publication_number=None)

Bases: PartyData

Derivation petitioner data in derivation proceedings.

Inherits all attributes from PartyData. Used in DER proceedings to represent the petitioning party claiming derivation.

class pyUSPTO.models.ptab.InterferenceDocumentData(document_identifier=None, document_name=None, document_size_quantity=None, document_ocr_text=None, document_title_text=None, interference_outcome_category=None, document_filing_date=None, decision_issue_date=None, decision_type_category=None, file_download_uri=None, statute_and_rule_bag=<factory>, issue_type_bag=<factory>)

Bases: object

Interference document metadata.

document_identifier

Unique identifier for the document.

document_name

Name of the document.

document_size_quantity

Size of the document in bytes.

document_ocr_text

Full OCR text of the document.

document_title_text

Title of the document.

interference_outcome_category

Outcome of the interference.

document_filing_date

Date the document was filed.

decision_issue_date

Date the decision was issued.

decision_type_category

Type of decision.

file_download_uri

URI to download the document.

statute_and_rule_bag

List of applicable statutes and rules.

issue_type_bag

List of issues addressed.

decision_issue_date: date | None = None

decision_type_category: str | None = None

document_filing_date: date | None = None

document_identifier: str | None = None

document_name: str | None = None

document_ocr_text: str | None = None

document_size_quantity: int | None = None

document_title_text: str | None = None

file_download_uri: str | None = None

classmethod from_dict(data, include_raw_data=False)

Create an InterferenceDocumentData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing document data from API response.

• include_raw_data (bool) – Ignored for this model.

Returns:

An instance of InterferenceDocumentData.

Return type:

InterferenceDocumentData

interference_outcome_category: str | None = None

issue_type_bag: list[str]

statute_and_rule_bag: list[str]

to_dict()

Convert the InterferenceDocumentData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.InterferenceMetaData(interference_style_name=None, interference_last_modified_date=None, interference_last_modified_date_time=None, declaration_date=None, file_download_uri=None)

Bases: object

Interference metadata.

interference_style_name

Style name of the interference.

interference_last_modified_date

Last modification date.

interference_last_modified_date_time

Last modification datetime.

declaration_date

Declaration date.

file_download_uri

URI to download ZIP of interference documents.

declaration_date: date | None = None

file_download_uri: str | None = None

classmethod from_dict(data, include_raw_data=False)

Create an InterferenceMetaData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing interference metadata from API response.

• include_raw_data (bool) – Ignored for this model.

Returns:

An instance of InterferenceMetaData.

Return type:

InterferenceMetaData

interference_last_modified_date: date | None = None

interference_last_modified_date_time: datetime | None = None

interference_style_name: str | None = None

to_dict()

Convert the InterferenceMetaData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.JuniorPartyData(application_number_text=None, counsel_name=None, grant_date=None, group_art_unit_number=None, inventor_name=None, real_party_in_interest_name=None, patent_number=None, patent_owner_name=None, technology_center_number=None, publication_date=None, publication_number=None)

Bases: PartyData

Junior party information in PTAB interference proceedings.

Inherits all attributes from PartyData. Represents the party with the later effective filing date in an interference.

class pyUSPTO.models.ptab.PTABAppealDecision(appeal_number=None, last_modified_date_time=None, appeal_document_category=None, appeal_meta_data=None, appellant_data=None, requestor_data=None, document_data=None, decision_data=None, raw_data=None)

Bases: object

Individual PTAB appeal decision record.

appeal_number

Appeal number.

last_modified_date_time

Last modification timestamp.

appeal_document_category

Document category.

appeal_meta_data

Appeal metadata.

appellant_data

Appellant information.

requestor_data

Third party requestor information.

document_data

Document metadata.

decision_data

Decision information.

raw_data

Raw JSON response data (if include_raw_data=True).

appeal_document_category: str | None = None

appeal_meta_data: AppealMetaData | None = None

appeal_number: str | None = None

appellant_data: AppellantData | None = None

decision_data: DecisionData | None = None

document_data: AppealDocumentData | None = None

classmethod from_dict(data, include_raw_data=False)

Create a PTABAppealDecision instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing appeal decision data from API response.

• include_raw_data (bool) – Whether to include raw JSON data in the instance.

Returns:

An instance of PTABAppealDecision.

Return type:

PTABAppealDecision

last_modified_date_time: datetime | None = None

raw_data: dict[str, Any] | None = None

requestor_data: RequestorData | None = None

to_dict()

Convert the PTABAppealDecision instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.PTABAppealResponse(count=0, request_identifier=None, patent_appeal_data_bag=<factory>, raw_data=None)

Bases: object

Response container for PTAB appeals search.

count

Total number of matching results.

request_identifier

UUID for the API request.

patent_appeal_data_bag

List of appeal decisions.

raw_data

Raw JSON response data (if include_raw_data=True).

count: int = 0

classmethod from_dict(data, include_raw_data=False)

Create a PTABAppealResponse instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing response data from API.

• include_raw_data (bool) – Whether to include raw JSON data in the instance.

Returns:

An instance of PTABAppealResponse.

Return type:

PTABAppealResponse

patent_appeal_data_bag: list[PTABAppealDecision]

raw_data: dict[str, Any] | None = None

request_identifier: str | None = None

to_dict()

Convert the PTABAppealResponse instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.PTABInterferenceDecision(interference_number=None, last_modified_date_time=None, interference_meta_data=None, senior_party_data=None, junior_party_data=None, additional_party_data_bag=<factory>, document_data=None, raw_data=None)

Bases: object

Individual PTAB interference decision record.

interference_number

Interference number.

last_modified_date_time

Last modification timestamp.

interference_meta_data

Interference metadata.

senior_party_data

Senior party information.

junior_party_data

Junior party information.

additional_party_data_bag

List of additional parties.

document_data

Document metadata.

raw_data

Raw JSON response data (if include_raw_data=True).

additional_party_data_bag: list[AdditionalPartyData]

document_data: InterferenceDocumentData | None = None

classmethod from_dict(data, include_raw_data=False)

Create a PTABInterferenceDecision instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing interference decision data from API response.

• include_raw_data (bool) – Whether to include raw JSON data in the instance.

Returns:

An instance of PTABInterferenceDecision.

Return type:

PTABInterferenceDecision

interference_meta_data: InterferenceMetaData | None = None

interference_number: str | None = None

junior_party_data: JuniorPartyData | None = None

last_modified_date_time: datetime | None = None

raw_data: dict[str, Any] | None = None

senior_party_data: SeniorPartyData | None = None

to_dict()

Convert the PTABInterferenceDecision instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.PTABInterferenceResponse(count=0, request_identifier=None, patent_interference_data_bag=<factory>, raw_data=None)

Bases: object

Response container for PTAB interferences search.

count

Total number of matching results.

request_identifier

UUID for the API request.

patent_interference_data_bag

List of interference decisions.

raw_data

Raw JSON response data (if include_raw_data=True).

count: int = 0

classmethod from_dict(data, include_raw_data=False)

Create a PTABInterferenceResponse instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing response data from API.

• include_raw_data (bool) – Whether to include raw JSON data in the instance.

Returns:

An instance of PTABInterferenceResponse.

Return type:

PTABInterferenceResponse

patent_interference_data_bag: list[PTABInterferenceDecision]

raw_data: dict[str, Any] | None = None

request_identifier: str | None = None

to_dict()

Convert the PTABInterferenceResponse instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.PTABTrialDocument(trial_document_category=None, last_modified_date_time=None, trial_number=None, trial_type_code=None, trial_meta_data=None, patent_owner_data=None, regular_petitioner_data=None, respondent_data=None, derivation_petitioner_data=None, document_data=None, decision_data=None, raw_data=None)

Bases: object

Individual trial document or decision record from PTAB document/decision search APIs.

Used by search_documents() and search_decisions() endpoints. Contains document-specific metadata (documentData) or decision information (decisionData), plus trial context. Differs from PTABTrialProceeding which represents the entire proceeding rather than individual documents within it.

trial_document_category

Category (Document or Decision).

last_modified_date_time

Last modification timestamp.

trial_number

Trial number (e.g., “IPR2023-00123”).

trial_type_code

Type of trial (IPR, PGR, CBM, DER).

trial_meta_data

Trial metadata.

patent_owner_data

Patent owner information.

regular_petitioner_data

Regular petitioner information.

respondent_data

Respondent information.

derivation_petitioner_data

Derivation petitioner information.

document_data

Document metadata (if document).

decision_data

Decision information (if decision).

raw_data

Raw JSON response data (if include_raw_data=True).

decision_data: TrialDecisionData | None = None

derivation_petitioner_data: DerivationPetitionerData | None = None

document_data: TrialDocumentData | None = None

classmethod from_dict(data, include_raw_data=False)

Create a PTABTrialDocument instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary with API response data containing PTAB trial document information.

• include_raw_data (bool) – If True, includes the raw API response data in the instance.

Returns:

A new instance populated with data from the dictionary.

Return type:

PTABTrialDocument

last_modified_date_time: datetime | None = None

patent_owner_data: PatentOwnerData | None = None

raw_data: dict[str, Any] | None = None

regular_petitioner_data: RegularPetitionerData | None = None

respondent_data: RespondentData | None = None

to_dict()

Convert the PTABTrialDocument instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

trial_document_category: str | None = None

trial_meta_data: TrialMetaData | None = None

trial_number: str | None = None

trial_type_code: str | None = None

class pyUSPTO.models.ptab.PTABTrialDocumentResponse(count=0, request_identifier=None, patent_trial_document_data_bag=<factory>, raw_data=None)

Bases: object

Response container for PTAB trial documents/decisions search.

count: int = 0

classmethod from_dict(data, include_raw_data=False)

Create a PTABTrialDocumentResponse instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary with API response data containing PTAB trial document response information.

• include_raw_data (bool) – If True, includes the raw API response data in the instance.

Returns:

A new instance populated with data from the dictionary.

Return type:

PTABTrialDocumentResponse

patent_trial_document_data_bag: list[PTABTrialDocument]

raw_data: dict[str, Any] | None = None

request_identifier: str | None = None

to_dict()

Convert the PTABTrialDocumentResponse instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.PTABTrialProceeding(trial_number=None, last_modified_date_time=None, trial_meta_data=None, patent_owner_data=None, regular_petitioner_data=None, respondent_data=None, derivation_petitioner_data=None, raw_data=None)

Bases: object

Individual PTAB trial proceeding record.

trial_number

Trial number (e.g., “IPR2023-00123”).

trial_record_identifier

UUID identifier for the trial record.

last_modified_date_time

Last modification timestamp.

trial_meta_data

Trial metadata.

patent_owner_data

Patent owner information.

regular_petitioner_data

Regular petitioner information.

respondent_data

Respondent information.

derivation_petitioner_data

Derivation petitioner information.

raw_data

Raw JSON response data (if include_raw_data=True).

derivation_petitioner_data: DerivationPetitionerData | None = None

classmethod from_dict(data, include_raw_data=False)

Create a PTABTrialProceeding instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing trial proceeding data from API response.

• include_raw_data (bool) – Whether to include raw JSON data in the instance.

Returns:

An instance of PTABTrialProceeding.

Return type:

PTABTrialProceeding

last_modified_date_time: datetime | None = None

patent_owner_data: PatentOwnerData | None = None

raw_data: dict[str, Any] | None = None

regular_petitioner_data: RegularPetitionerData | None = None

respondent_data: RespondentData | None = None

to_dict()

Convert the PTABTrialProceeding instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

trial_meta_data: TrialMetaData | None = None

trial_number: str | None = None

class pyUSPTO.models.ptab.PTABTrialProceedingResponse(count=0, request_identifier=None, patent_trial_proceeding_data_bag=<factory>, raw_data=None)

Bases: object

Response container for PTAB trial proceedings search.

count

Total number of matching results.

request_identifier

UUID for the API request.

patent_trial_proceeding_data_bag

List of trial proceedings.

raw_data

Raw JSON response data (if include_raw_data=True).

count: int = 0

classmethod from_dict(data, include_raw_data=False)

Create a PTABTrialProceedingResponse instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing response data from API.

• include_raw_data (bool) – Whether to include raw JSON data in the instance.

Returns:

An instance of PTABTrialProceedingResponse.

Return type:

PTABTrialProceedingResponse

patent_trial_proceeding_data_bag: list[PTABTrialProceeding]

raw_data: dict[str, Any] | None = None

request_identifier: str | None = None

to_dict()

Convert the PTABTrialProceedingResponse instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.PatentOwnerData(application_number_text=None, counsel_name=None, grant_date=None, group_art_unit_number=None, inventor_name=None, real_party_in_interest_name=None, patent_number=None, patent_owner_name=None, technology_center_number=None, publication_date=None, publication_number=None)

Bases: PartyData

Party data for a patent owner in PTAB trial proceedings.

Inherits all attributes from PartyData. Used in IPR, PGR, CBM, and DER proceedings to represent the patent holder.

class pyUSPTO.models.ptab.RegularPetitionerData(counsel_name=None, real_party_in_interest_name=None)

Bases: object

Regular petitioner information.

counsel_name

Name of counsel.

real_party_in_interest_name

Real party in interest name.

counsel_name: str | None = None

classmethod from_dict(data, include_raw_data=False)

Create a RegularPetitionerData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing petitioner data from API response.

• include_raw_data (bool) – Ignored for this model.

Returns:

An instance of RegularPetitionerData.

Return type:

RegularPetitionerData

real_party_in_interest_name: str | None = None

to_dict()

Convert the RegularPetitionerData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.RequestorData(third_party_name=None)

Bases: object

Third party requestor information.

third_party_name

Name of the third party.

classmethod from_dict(data, include_raw_data=False)

Create a RequestorData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing requestor data from API response.

• include_raw_data (bool) – Ignored for this model.

Returns:

An instance of RequestorData.

Return type:

RequestorData

third_party_name: str | None = None

to_dict()

Convert the RequestorData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.RespondentData(application_number_text=None, counsel_name=None, grant_date=None, group_art_unit_number=None, inventor_name=None, real_party_in_interest_name=None, patent_number=None, patent_owner_name=None, technology_center_number=None, publication_date=None, publication_number=None)

Bases: PartyData

Respondent party data in derivation proceedings.

Inherits all attributes from PartyData. Used in DER proceedings to represent the responding party.

class pyUSPTO.models.ptab.SeniorPartyData(application_number_text=None, counsel_name=None, grant_date=None, group_art_unit_number=None, inventor_name=None, real_party_in_interest_name=None, patent_number=None, patent_owner_name=None, technology_center_number=None, publication_date=None, publication_number=None)

Bases: PartyData

Senior party information in PTAB interference proceedings.

Inherits all attributes from PartyData. Represents the party with the earlier effective filing date in an interference.

class pyUSPTO.models.ptab.TrialDecisionData(statute_and_rule_bag=<factory>, decision_issue_date=None, decision_type_category=None, issue_type_bag=<factory>, trial_outcome_category=None)

Bases: object

Metadata for a decision in a PTAB trial.

statute_and_rule_bag

List of applicable statutes and rules.

decision_issue_date

Date issued.

decision_type_category

Type of decision (e.g. “Final Written Decision”).

issue_type_bag

List of issues addressed.

trial_outcome_category

Outcome (e.g., “Denied”).

decision_issue_date: date | None = None

decision_type_category: str | None = None

classmethod from_dict(data)

Create a TrialDecisionData instance from a dictionary.

Parameters:

data (dict[str, Any]) – Dictionary with API response data containing trial decision information.

Returns:

A new instance populated with data from the dictionary.

Return type:

TrialDecisionData

issue_type_bag: list[str]

statute_and_rule_bag: list[str]

to_dict()

Convert the TrialDecisionData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

trial_outcome_category: str | None = None

class pyUSPTO.models.ptab.TrialDocumentData(document_category=None, document_filing_date=None, document_identifier=None, document_name=None, document_number=None, document_size_quantity=None, document_ocr_text=None, document_title_text=None, document_type_description_text=None, file_download_uri=None, filing_party_category=None)

Bases: object

Metadata for a document in a PTAB trial.

document_category

Category of the document.

document_filing_date

Filing date.

document_identifier

Unique ID.

document_name

Filename.

document_number

Document number in the proceeding.

document_size_quantity

Size in bytes.

document_ocr_text

OCR text content.

document_title_text

Title of the document.

document_type_description_text

Description of document type.

file_download_uri

URL to download the file.

filing_party_category

Who filed (e.g., “Petitioner”).

mime_type_identifier

MIME type (e.g., “application/pdf”).

document_status

Public status.

document_category: str | None = None

document_filing_date: date | None = None

document_identifier: str | None = None

document_name: str | None = None

document_number: str | None = None

document_ocr_text: str | None = None

document_size_quantity: int | None = None

document_title_text: str | None = None

document_type_description_text: str | None = None

file_download_uri: str | None = None

filing_party_category: str | None = None

classmethod from_dict(data, include_raw_data=False)

Create a TrialDocumentData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing document data from API response.

• include_raw_data (bool) – Ignored for this model.

Returns:

An instance of TrialDocumentData.

Return type:

TrialDocumentData

to_dict()

Convert the TrialDocumentData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

class pyUSPTO.models.ptab.TrialMetaData(petition_filing_date=None, accorded_filing_date=None, trial_last_modified_date_time=None, trial_last_modified_date=None, trial_status_category=None, trial_type_code=None, file_download_uri=None, termination_date=None, latest_decision_date=None, institution_decision_date=None)

Bases: object

Trial metadata including status, dates, and download URI.

petition_filing_date

Date the petition was filed.

accorded_filing_date

The filing date accorded to the petition.

trial_last_modified_date_time

Last modification timestamp.

trial_last_modified_date

Last modification date.

trial_status_category

Status of the trial (e.g., “Institution Denied”, “Instituted”).

trial_type_code

Type of trial (IPR, PGR, CBM, DER).

file_download_uri

URI to download ZIP of all trial documents.

termination_date

Date the trial was terminated.

latest_decision_date

Date of the most recent decision.

institution_decision_date

Date of the institution decision.

accorded_filing_date: date | None = None

file_download_uri: str | None = None

classmethod from_dict(data, include_raw_data=False)

Create a TrialMetaData instance from a dictionary.

Parameters:

• data (dict[str, Any]) – Dictionary containing trial metadata from API response.

• include_raw_data (bool) – Ignored for this model (no raw_data field).

Returns:

An instance of TrialMetaData.

Return type:

TrialMetaData

institution_decision_date: date | None = None

latest_decision_date: date | None = None

petition_filing_date: date | None = None

termination_date: date | None = None

to_dict()

Convert the TrialMetaData instance to a dictionary.

Returns:

Dictionary with camelCase keys and None values filtered.

Return type:

Dict[str, Any]

trial_last_modified_date: date | None = None

trial_last_modified_date_time: datetime | None = None

trial_status_category: str | None = None

trial_type_code: str | None = None