cmd

Documentation

Index

• func Execute()
• type AppDocumentSummary
• type AppDocumentTextBatchResult
• type AppDocumentTextResult
• type AppDocumentTextSkip
• type AppSummary
• type ContinuitySummary
• type EventSummary
• type FamilyApplicationRef
• type FamilyNode
• type FamilyResult
• type ForeignPrioritySummary
• type OutputOptions
• type ProsecutionTimelineDocument
• type ProsecutionTimelineResult

Functions

func Execute

func Execute()

Execute runs the root command and exits with the appropriate code.

Types

type AppDocumentSummary

type AppDocumentSummary struct {
	Index               int      `json:"index"`
	ApplicationNumber   string   `json:"applicationNumber"`
	OfficialDate        string   `json:"officialDate"`
	DocumentIdentifier  string   `json:"documentIdentifier"`
	DocumentCode        string   `json:"documentCode"`
	Description         string   `json:"description"`
	Direction           string   `json:"direction,omitempty"`
	AvailableFormats    []string `json:"availableFormats"`
	PreferredTextFormat string   `json:"preferredTextFormat,omitempty"`
	CanExtractText      bool     `json:"canExtractText"`
}

type AppDocumentTextBatchResult

type AppDocumentTextBatchResult struct {
	ApplicationNumber string                  `json:"applicationNumber"`
	RequestedFormat   string                  `json:"requestedFormat"`
	TotalDocuments    int                     `json:"totalDocuments"`
	ExtractedCount    int                     `json:"extractedCount"`
	SkippedCount      int                     `json:"skippedCount"`
	Documents         []AppDocumentTextResult `json:"documents"`
	Skipped           []AppDocumentTextSkip   `json:"skipped,omitempty"`
}

type AppDocumentTextResult

type AppDocumentTextResult struct {
	ApplicationNumber  string   `json:"applicationNumber"`
	DocumentIndex      int      `json:"documentIndex"`
	DocumentIdentifier string   `json:"documentIdentifier"`
	DocumentCode       string   `json:"documentCode"`
	Description        string   `json:"description"`
	OfficialDate       string   `json:"officialDate"`
	Direction          string   `json:"direction,omitempty"`
	Format             string   `json:"format"`
	AvailableFormats   []string `json:"availableFormats"`
	EntryNames         []string `json:"entryNames,omitempty"`
	WordCount          int      `json:"wordCount"`
	CharacterCount     int      `json:"characterCount"`
	Text               string   `json:"text"`
}

type AppDocumentTextSkip

type AppDocumentTextSkip struct {
	DocumentIndex      int      `json:"documentIndex"`
	DocumentIdentifier string   `json:"documentIdentifier"`
	DocumentCode       string   `json:"documentCode"`
	Description        string   `json:"description"`
	AvailableFormats   []string `json:"availableFormats"`
	Reason             string   `json:"reason"`
}

type AppSummary

type AppSummary struct {
	ApplicationNumber    string                   `json:"applicationNumber"`
	PatentNumber         string                   `json:"patentNumber,omitempty"`
	Title                string                   `json:"title"`
	Status               string                   `json:"status"`
	FilingDate           string                   `json:"filingDate"`
	GrantDate            string                   `json:"grantDate,omitempty"`
	Applicant            string                   `json:"applicant"`
	Inventors            []string                 `json:"inventors"`
	Examiner             string                   `json:"examiner,omitempty"`
	ArtUnit              string                   `json:"artUnit,omitempty"`
	CPC                  []string                 `json:"cpc,omitempty"`
	EntityStatus         string                   `json:"entityStatus,omitempty"`
	PTADays              int                      `json:"ptaDays"`
	Parents              []ContinuitySummary      `json:"parents,omitempty"`
	Children             []ContinuitySummary      `json:"children,omitempty"`
	CurrentAssignee      string                   `json:"currentAssignee,omitempty"`
	RecentEvents         []EventSummary           `json:"recentEvents,omitempty"`
	ForeignPriority      []ForeignPrioritySummary `json:"foreignPriority,omitempty"`
	ForeignPriorityCount int                      `json:"foreignPriorityCount"`
	DocumentCount        int                      `json:"documentCount"`
	LastDocument         string                   `json:"lastDocument,omitempty"`
	LastUpdated          string                   `json:"lastUpdated,omitempty"`
}

AppSummary is the flattened, agent-friendly summary of a patent application.

type ContinuitySummary

type ContinuitySummary struct {
	ApplicationNumber string `json:"applicationNumber"`
	PatentNumber      string `json:"patentNumber,omitempty"`
	Relationship      string `json:"relationship"`
	FilingDate        string `json:"filingDate,omitempty"`
	Status            string `json:"status,omitempty"`
}

ContinuitySummary is a flattened view of a parent or child relationship.

type EventSummary

type EventSummary struct {
	Date        string `json:"date"`
	Code        string `json:"code"`
	Description string `json:"description"`
}

EventSummary is a flattened view of a prosecution event.

type FamilyApplicationRef

type FamilyApplicationRef struct {
	ApplicationNumber string `json:"applicationNumber"`
	Relationship      string `json:"relationship"`
}

FamilyApplicationRef is a deduplicated family member with relationship label.

type FamilyNode

type FamilyNode struct {
	ApplicationNumber string       `json:"applicationNumber"`
	PatentNumber      string       `json:"patentNumber,omitempty"`
	Title             string       `json:"title,omitempty"`
	Status            string       `json:"status,omitempty"`
	FilingDate        string       `json:"filingDate,omitempty"`
	Relationship      string       `json:"relationship,omitempty"`
	Children          []FamilyNode `json:"children,omitempty"`
}

FamilyNode represents a single node in the patent family tree.

type FamilyResult

type FamilyResult struct {
	Root                  string                 `json:"root"`
	Tree                  FamilyNode             `json:"tree"`
	AllApplicationNumbers []FamilyApplicationRef `json:"allApplicationNumbers"`
	TotalMembers          int                    `json:"totalMembers"`
}

FamilyResult is the top-level output for the family command.

type ForeignPrioritySummary

type ForeignPrioritySummary struct {
	IPOffice          string `json:"ipOffice"`
	ApplicationNumber string `json:"applicationNumber"`
	FilingDate        string `json:"filingDate"`
}

ForeignPrioritySummary is a flattened foreign priority claim.

type OutputOptions

type OutputOptions struct {
	Format  string
	Quiet   bool
	Minify  bool
	NoColor bool
}

OutputOptions captures the resolved output flags for a single invocation.

type ProsecutionTimelineDocument

type ProsecutionTimelineDocument struct {
	OfficialDate        string   `json:"officialDate"`
	DocumentCode        string   `json:"documentCode"`
	Description         string   `json:"description,omitempty"`
	DocumentIdentifier  string   `json:"documentIdentifier,omitempty"`
	Direction           string   `json:"direction,omitempty"`
	AvailableFormats    []string `json:"availableFormats,omitempty"`
	PreferredTextFormat string   `json:"preferredTextFormat,omitempty"`
}

type ProsecutionTimelineResult

type ProsecutionTimelineResult struct {
	ApplicationNumber string                        `json:"applicationNumber"`
	FilingDate        string                        `json:"filingDate,omitempty"`
	GrantDate         string                        `json:"grantDate,omitempty"`
	Status            string                        `json:"status,omitempty"`
	Events            []EventSummary                `json:"events,omitempty"`
	KeyDocuments      []ProsecutionTimelineDocument `json:"keyDocuments,omitempty"`
}