epo_ops

package module

Go to main page

Versions in this module

v1

v1.1.3

Mar 12, 2026

v1.1.2

Mar 12, 2026

v1.1.1

Mar 12, 2026

v1.1.0

Mar 11, 2026

Changes in this version

type ClassificationData

+ Ancestors []ClassificationChild

v1.0.0

Mar 11, 2026

Changes in this version

+ const StatusActive

+ const StatusExpired

+ const StatusLapsed

+ const StatusPending

+ const StatusRevoked

+ const StatusUnknown

+ const StatusWithdrawn

+ var LCodeStatusMapping = map[string]string

+ func DeriveOverallStatus(events []LegalEvent) string

+ func DerivePatentStatus(events []LegalEvent, targetCountry string) string

+ func ValidateBulkNumbers(numbers []string, format string) error

+ type ApplicationReference struct

+ Country string

+ Date string

+ DocID string

+ DocNumber string

+ Kind string

+ type ClassificationChild struct

+ Level int

+ Symbol string

+ Title string

+ type ClassificationData struct

+ Children []ClassificationChild

+ Level int

+ SchemeType string

+ Symbol string

+ Title string

+ func ParseClassificationSchema(xmlData string) (*ClassificationData, error)

type Client

+ func (c *Client) ConvertPatentNumberMultipleRaw(ctx context.Context, refType, inputFormat string, numbers []string, ...) (string, error)

+ func (c *Client) ConvertPatentNumberRaw(ctx context.Context, refType, inputFormat, number, outputFormat string) (string, error)

+ func (c *Client) GetClassificationMappingRaw(ctx context.Context, inputFormat, class, subclass, outputFormat string, ...) (string, error)

+ func (c *Client) GetClassificationSchemaMultipleRaw(ctx context.Context, classes []string) (string, error)

+ func (c *Client) GetClassificationSchemaRaw(ctx context.Context, class string, ancestors, navigation bool) (string, error)

+ func (c *Client) GetClassificationSchemaSubclassRaw(ctx context.Context, class, subclass string, ancestors, navigation bool) (string, error)

+ func (c *Client) GetClassificationStatisticsRaw(ctx context.Context, query string) (string, error)

+ func (c *Client) GetDescriptionRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetFamilyRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetFulltextRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetLegalRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetPublishedEquivalentsRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetRegisterBiblioMultipleRaw(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetRegisterBiblioRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetRegisterEventsMultipleRaw(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetRegisterEventsRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetRegisterProceduralStepsMultipleRaw(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetRegisterProceduralStepsRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetRegisterUNIPMultipleRaw(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetRegisterUNIPRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) SearchRaw(ctx context.Context, query string, rangeStr string) (string, error)

+ type DataValidationError struct

+ Message string

+ MissingField string

+ Parser string

+ func (e *DataValidationError) Error() string

+ type DescriptionData struct

+ Country string

+ DocNumber string

+ Kind string

+ Language string

+ Paragraphs []Paragraph

+ PatentNumber string

+ XMLName xml.Name

+ func ParseDescription(xmlData string) (*DescriptionData, error)

+ type EquivalentPatent struct

+ Country string

+ DocNumber string

+ Kind string

+ type EquivalentsData struct

+ Equivalents []EquivalentPatent

+ PatentNumber string

+ XMLName xml.Name

+ func ParseEquivalents(xmlData string) (*EquivalentsData, error)

+ type FamilyData struct

+ Countries []string

+ FamilyID string

+ Legal bool

+ Members []FamilyMember

+ PatentNumber string

+ TotalCount int

+ XMLName xml.Name

+ func ParseFamily(xmlData string) (*FamilyData, error)

+ type FamilyMember struct

+ Applicants []string

+ ApplicationRef ApplicationReference

+ Country string

+ Date string

+ DocNumber string

+ FamilyID string

+ Kind string

+ PriorityClaims []PriorityClaim

+ Title string

+ type FulltextData struct

+ Abstract *AbstractData

+ Biblio *BiblioData

+ Claims *ClaimsData

+ Country string

+ Description *DescriptionData

+ DocNumber string

+ Kind string

+ Language string

+ Status string

+ XMLName xml.Name

+ func ParseFulltext(xmlData string) (*FulltextData, error)

+ type LegalData struct

+ FamilyID string

+ LegalEvents []LegalEvent

+ PatentNumber string

+ XMLName xml.Name

+ func ParseLegal(xmlData string) (*LegalData, error)

+ type LegalEvent struct

+ Code string

+ Country string

+ Date string

+ DateMigr string

+ Description string

+ EventCode string

+ Fields map[string]string

+ Influence string

+ type NumberConversionData struct

+ Country string

+ Date string

+ DocNumber string

+ InputFormat string

+ Kind string

+ OutputFormat string

+ func ParseNumberConversion(xmlData string) (*NumberConversionData, error)

+ type Paragraph struct

+ ID string

+ Num string

+ Text string

+ type PatentStatus struct

+ Code string

+ Date string

+ Description string

+ type PriorityClaim struct

+ Active string

+ Country string

+ Date string

+ DocNumber string

+ Kind string

+ Sequence string

+ type RegisterEvent struct

+ Category string

+ Date string

+ Description string

+ EventCode string

+ GazetteDate string

+ GazetteNum string

+ ID string

+ type RegisterEventsData struct

+ Events []RegisterEvent

+ PatentNumber string

+ Query string

+ Statuses []PatentStatus

+ func ParseRegisterEvents(xmlData string) (*RegisterEventsData, error)

+ type SearchResult struct

+ Country string

+ DocNumber string

+ FamilyID string

+ Kind string

+ System string

+ Title string

+ type SearchResultData struct

+ Query string

+ RangeBegin int

+ RangeEnd int

+ Results []SearchResult

+ TotalCount int

+ XMLName xml.Name

+ func ParseSearch(xmlData string) (*SearchResultData, error)

+ type XMLParseError struct

+ Cause error

+ Element string

+ Parser string

+ XMLSample string

+ func (e *XMLParseError) Error() string

+ func (e *XMLParseError) Unwrap() error

v0

v0.1.0

Oct 24, 2025

v0.0.1

Oct 25, 2025

Changes in this version

+ const ConstituentAbstract

+ const ConstituentBiblio

+ const ConstituentFullCycle

+ const EndpointAbstract

+ const EndpointBiblio

+ const EndpointClaims

+ const EndpointDescription

+ const EndpointFamily

+ const EndpointFulltext

+ const EndpointImages

+ const EndpointLegal

+ const EndpointRegister

+ const EndpointSearch

+ const FormatDocDB

+ const FormatEPODOC

+ const FormatOriginal

+ const ImageTypeFirstPage

+ const ImageTypeFullImage

+ const ImageTypeThumbnail

+ const RefTypeApplication

+ const RefTypePriority

+ const RefTypePublication

+ func GetEmbeddedXSD(name string) (string, bool)

+ func NormalizeToDocdb(number string) (string, error)

+ func ValidateDate(date string) error

+ func ValidateDocdbFormat(number string) error

+ func ValidateEpodocFormat(number string) error

+ func ValidateFormat(format, number string) error

+ func ValidateOriginalFormat(number string) error

+ func ValidatePatentNumber(number string) error

+ func ValidateRefType(refType string) error

+ func ValidateTimeRange(timeRange string) error

+ type AbstractData struct

+ Country string

+ DocNumber string

+ Kind string

+ Language string

+ PatentNumber string

+ Text string

+ XMLName xml.Name

+ func ParseAbstract(xmlData string) (*AbstractData, error)

+ type AmbiguousPatentError struct

+ Country string

+ KindCodes []string

+ Message string

+ Number string

+ func (e *AmbiguousPatentError) Error() string

+ type AuthError struct

+ Message string

+ StatusCode int

+ func (e *AuthError) Error() string

+ type Authenticator struct

+ func NewAuthenticator(consumerKey, consumerSecret string, httpClient *http.Client) *Authenticator

+ func (a *Authenticator) ClearToken()

+ func (a *Authenticator) GetToken(ctx context.Context) (string, error)

+ type BiblioData struct

+ Applicants []Party

+ CPCClasses []CPCClass

+ Country string

+ DocNumber string

+ FamilyID string

+ IPCClasses []string

+ Inventors []Party

+ Kind string

+ PatentNumber string

+ PublicationDate string

+ Titles map[string]string

+ XMLName xml.Name

+ func ParseBiblio(xmlData string) (*BiblioData, error)

+ type BulkOptions struct

+ MaxConcurrent int

+ OnProgress func(current, total int)

+ type CPCClass struct

+ Class string

+ Full string

+ MainGroup string

+ Section string

+ Subclass string

+ Subgroup string

+ type Claim struct

+ Number int

+ Text string

+ type ClaimsData struct

+ Claims []Claim

+ Country string

+ DocNumber string

+ Kind string

+ Language string

+ PatentNumber string

+ XMLName xml.Name

+ func ParseClaims(xmlData string) (*ClaimsData, error)

+ type Client struct

+ func NewClient(config *Config) (*Client, error)

+ func (c *Client) ConvertPatentNumber(ctx context.Context, refType, inputFormat, number, outputFormat string) (string, error)

+ func (c *Client) ConvertPatentNumberMultiple(ctx context.Context, refType, inputFormat string, numbers []string, ...) (string, error)

+ func (c *Client) GetAbstract(ctx context.Context, refType, format, number string) (*AbstractData, error)

+ func (c *Client) GetAbstractMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetAbstractRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetAbstractsBulk(ctx context.Context, refType, format string, numbers []string, ...) ([]string, error)

+ func (c *Client) GetBiblio(ctx context.Context, refType, format, number string) (*BiblioData, error)

+ func (c *Client) GetBiblioMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetBiblioRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetBibliosBulk(ctx context.Context, refType, format string, numbers []string, ...) ([]string, error)

+ func (c *Client) GetClaims(ctx context.Context, refType, format, number string) (*ClaimsData, error)

+ func (c *Client) GetClaimsBulk(ctx context.Context, refType, format string, numbers []string, ...) ([]string, error)

+ func (c *Client) GetClaimsMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetClaimsRaw(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetClassificationMapping(ctx context.Context, inputFormat, class, subclass, outputFormat string, ...) (string, error)

+ func (c *Client) GetClassificationMedia(ctx context.Context, mediaName string, asAttachment bool) ([]byte, error)

+ func (c *Client) GetClassificationSchema(ctx context.Context, class string, ancestors, navigation bool) (string, error)

+ func (c *Client) GetClassificationSchemaMultiple(ctx context.Context, classes []string) (string, error)

+ func (c *Client) GetClassificationSchemaSubclass(ctx context.Context, class, subclass string, ancestors, navigation bool) (string, error)

+ func (c *Client) GetClassificationStatistics(ctx context.Context, query string) (string, error)

+ func (c *Client) GetDescription(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetDescriptionMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetDescriptionsBulk(ctx context.Context, refType, format string, numbers []string, ...) ([]string, error)

+ func (c *Client) GetFamily(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetFamilyWithBiblio(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetFamilyWithBiblioMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetFamilyWithLegal(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetFamilyWithLegalMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetFullCycleMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetFulltext(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetFulltextMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetFulltextsBulk(ctx context.Context, refType, format string, numbers []string, ...) ([]string, error)

+ func (c *Client) GetImage(ctx context.Context, country, number, kind, imageType string, page int) ([]byte, error)

+ func (c *Client) GetImageInquiry(ctx context.Context, refType, format, number string) (*ImageInquiry, error)

+ func (c *Client) GetImagePOST(ctx context.Context, page int, identifier string) ([]byte, error)

+ func (c *Client) GetLastQuota() *QuotaInfo

+ func (c *Client) GetLegal(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetLegalMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetPublishedEquivalents(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetPublishedEquivalentsMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetRegisterBiblio(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetRegisterBiblioMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetRegisterEvents(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetRegisterEventsMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetRegisterProceduralSteps(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetRegisterProceduralStepsMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetRegisterUNIP(ctx context.Context, refType, format, number string) (string, error)

+ func (c *Client) GetRegisterUNIPMultiple(ctx context.Context, refType, format string, numbers []string) (string, error)

+ func (c *Client) GetUsageStats(ctx context.Context, timeRange string) (*UsageStats, error)

+ func (c *Client) Search(ctx context.Context, query string, rangeStr string) (string, error)

+ func (c *Client) SearchRegister(ctx context.Context, query, rangeSpec string) (string, error)

+ func (c *Client) SearchRegisterWithConstituent(ctx context.Context, constituent, query, rangeSpec string) (string, error)

+ func (c *Client) SearchWithConstituent(ctx context.Context, constituent, query string, rangeStr string) (string, error)

+ type Config struct

+ AuthURL string

+ BaseURL string

+ ConsumerKey string

+ ConsumerSecret string

+ MaxRetries int

+ RetryDelay time.Duration

+ Timeout time.Duration

+ func DefaultConfig() *Config

+ type ConfigError struct

+ Message string

+ func (e *ConfigError) Error() string

+ type DocumentInstance struct

+ Description string

+ DocType string

+ Formats []string

+ Link string

+ NumberOfPages int

+ type ImageInquiry struct

+ DocumentInstances []DocumentInstance

+ func ParseImageInquiry(xmlData string) (*ImageInquiry, error)

+ type NotFoundError struct

+ Message string

+ Resource string

+ func (e *NotFoundError) Error() string

+ type NotImplementedError struct

+ Message string

+ func (e *NotImplementedError) Error() string

+ type OPSError struct

+ Code string

+ HTTPStatus int

+ Message string

+ MoreInfo string

+ func (e *OPSError) Error() string

+ type Party struct

+ Country string

+ Name string

+ type PatentNumber struct

+ Country string

+ Kind string

+ Number string

+ func ParsePatentNumber(number string) PatentNumber

+ type QuotaExceededError struct

+ Message string

+ func (e *QuotaExceededError) Error() string

+ type QuotaInfo struct

+ Images QuotaMetric

+ Individual QuotaMetric

+ IndividualHeader string

+ Registered QuotaMetric

+ RegisteredHeader string

+ Status string

+ ThrottlingControl string

+ func ParseQuotaHeaders(headers http.Header) *QuotaInfo

+ type QuotaMetric struct

+ Limit int

+ Used int

+ func (q *QuotaMetric) UsagePercent() float64

+ type ServiceUnavailableError struct

+ Message string

+ RetryAfter string

+ StatusCode int

+ func (e *ServiceUnavailableError) Error() string

+ type UsageEntry struct

+ MessageCount int

+ Service string

+ Timestamp int64

+ TotalResponseSize int64

+ type UsageStats struct

+ Entries []UsageEntry

+ TimeRange string

+ type ValidationError struct

+ Field string

+ Format string

+ Message string

+ Value string

+ func (e *ValidationError) Error() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL