wipo-gbd-transformation 1.1.105__py3-none-any.whl

gbdtransformation/brands/gmtm/schema

@@ -0,0 +1,86 @@
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkApplication
+__________/TradeMarkDetails
+____________/TradeMark
+______________/ApplicantDetails
+________________/Applicant
+__________________/ApplicantAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/ApplicationDate
+______________/ApplicationLanguageCode
+______________/ApplicationNumber
+______________/ExpiryDate
+______________/GoodsServicesDetails
+________________/GoodsServices
+__________________/ClassDescriptionDetails
+____________________/ClassDescription
+______________________/ClassNumber
+______________________/GoodsServicesDescription
+______________________/GoodsServicesDescription[@languageCode=en]
+______________/KindMark
+______________/MarkCurrentStatusCode
+______________/MarkCurrentStatusDate
+______________/MarkDisclaimerDetails
+________________/MarkDisclaimer
+________________/MarkDisclaimer[@languageCode=en]
+______________/MarkEventDetails
+________________/MarkEvent
+__________________/MarkEventCode
+__________________/MarkEventDate
+__________________/OfficeSpecificMarkEventCode
+__________________/OfficeSpecificMarkEventDescription
+__________________/OfficeSpecificMarkEventDescription[@languageCode=en]
+______________/MarkFeature
+______________/MarkImageDetails
+________________/MarkImage
+__________________/MarkImageCategory
+____________________/CategoryCodeDetails
+______________________/CategoryCode
+____________________/CategoryKind
+____________________/CategoryVersion
+__________________/MarkImageColourClaimedText
+__________________/MarkImageColourClaimedText[@languageCode=en]
+__________________/MarkImageFileFormat
+__________________/MarkImageFilename
+______________/PriorityDetails
+________________/Priority
+__________________/PriorityCountryCode
+__________________/PriorityDate
+__________________/PriorityNumber
+______________/PublicationDetails
+________________/Publication
+__________________/PublicationDate
+______________/RegistrationDate
+______________/RegistrationNumber
+______________/RegistrationOfficeCode
+______________/RepresentativeDetails
+________________/Representative
+__________________/RepresentativeAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/WordMarkSpecification
+________________/MarkVerbalElementText
+________________/MarkVerbalElementText[@languageCode=en]
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/brands/gmtm/template.yml

@@ -0,0 +1 @@
+{% include "ipas/template.yml" %}

gbdtransformation/brands/gstm/__init__.py

@@ -0,0 +1,2 @@
+render = 'JSON'
+source = 'national'

gbdtransformation/brands/gstm/filters.py

@@ -0,0 +1,75 @@
+import re
+import os
+
+def transform_name_address(entities, app_lang):
+    names = {}
+    cc = []
+    if isinstance(entities, list):
+        for entity in entities:
+            for name in entity.get('fullName', []):
+                names.setdefault(name.languageCode, [])
+                names[name.languageCode].append(name.text)
+            cc.append(entity.countryCode)
+
+    return {'names': names, 'cc': cc}
+
+def guess_image_name(appnum):
+    appnum = appnum.replace('/', '').replace('-', '')
+    return os.path.join(appnum.zfill(4)[-4:-2],
+            appnum.zfill(4)[-2:],
+            '%s.png' % appnum)
+
+def transform_goods_services(gservices, app_lang):
+    gs_terms = {}
+    if isinstance(gservices, list):
+        for gservice in gservices:
+            gs_terms.setdefault(str(gservice.nice), {})
+            if not gservice.terms:
+                continue
+            for language in gservice.terms.keys() or {}:
+                terms = gservice.terms[language]
+                for term in terms:
+                    gs_terms[str(gservice.nice)].setdefault(language, [])
+                    gs_terms[str(gservice.nice)][language].append(term)
+
+    return gs_terms
+
+def transform_unclassified_goods_services(gservice, app_lang):
+    if not gservice: return {}
+
+    gs_terms = {}
+    for language in gservice.keys() or {}:
+        terms = gservice[language]
+        for term in terms:
+            gs_terms.setdefault(language, [])
+            gs_terms[language].append(term)
+
+    return gs_terms
+
+def filter_events(events):
+    events_names = []
+    if isinstance(events, list):
+        for event in events:
+            events_names.append(event.gbdKind)
+
+    return set(events_names)
+
+# if combined, then image type has Word and Device
+def get_image_type(mark_feature):
+    if mark_feature == 'Combined':
+        return ['Word', 'Device']
+    if mark_feature == 'Figurative':
+        return ['Device']
+
+    return [mark_feature]
+
+# only top 2 for classification
+# might be useful for faceting
+def cl_top2(classes):
+    return ['.'.join(c.split('.')[:2]) for c in classes]
+
+def validate_status(status):
+    if status not in ['Ended', 'Expired', 'Registered', 'Pending', 'Unknown']:
+         raise Exception('Invalid Status: %s' % status)
+    else:
+        return status[0:3].upper()

gbdtransformation/brands/gstm/template.gs.yml

@@ -0,0 +1,56 @@
+{% from 'navigation.tmpl' import match %}
+
+{% if not gbdStatus == 'Delete' %}
+office: {{ registrationOfficeCode }}
+status: {{ gbdStatus | validate_status }}
+{% call(verbal) match('wordMarkSpecification.markVerbalElement', brand) %}
+brandName: {{ verbal.text }}
+{% endcall %}
+{% call(image) match('markImageDetails', brand) %}
+imageName: {{ applicationNumber | guess_image_name }}
+{% endcall %}
+
+applicationNumber: {{ applicationNumber }}
+registrationNumber: {{ registrationNumber }}
+applicationRefNumber: {{ applicationRefNumber }}
+
+applicationDate: {{ applicationDate }}
+registrationDate: {{ registrationDate }}
+
+
+{% set applicants_info = applicants | transform_name_address(applicationLanguageCode) %}
+{% for k,v in applicants_info.names.items() %}
+applicant: {% for x in v %}
+  - {{ x }}
+{% endfor %}
+{% endfor %}
+applicantCountryCode:
+{% for cc in applicants_info.cc %}
+  - {{ cc }}
+{% endfor %}
+
+{% set gservices_info = goodsServicesClassification | transform_goods_services(applicationLanguageCode) %}
+
+{% for class,langs in gservices_info.items() %}
+{% set name = 'goodsServices_' + class %}
+
+{% for lang,terms in gservices_info[class].items() %}
+{% set name = name + '_' + lang %}
+{{ name | field_name }}:
+{% for term in terms %}
+  - {{ term | remove_trailing(',', '.') }}
+{% endfor %}
+{% endfor %}
+{% endfor %}
+
+{% set gservices_unclassified = goodsServicesUnclassified | transform_unclassified_goods_services(applicationLanguageCode) %}
+{% set name = 'goodsServices' %}
+{% for lang,terms in gservices_unclassified.items() %}
+{% set name = name + '_' + lang %}
+{{ name | field_name }}:
+{% for term in terms %}
+  - {{ term | remove_trailing(',', '.') }}
+{% endfor %}
+{% endfor %}
+{% else %}
+{% endif %}

gbdtransformation/brands/gstm/template.yml

@@ -0,0 +1,32 @@
+{% from 'navigation.tmpl' import match %}
+
+{% if gbdStatus == 'Registered' or gbdStatus == 'Pending' %}
+office: {{ registrationOfficeCode }}
+status: {{ gbdStatus }}
+
+applicationNumber: {{ applicationNumber }}
+registrationNumber: {{ registrationNumber }}
+applicationDate: {{ applicationDate }}
+registrationDate: {{ registrationDate }}
+
+
+{% for applicant in applicants %}
+applicant:
+  name: {{ applicant.fullName[0].text }}
+  address: {{ applicant.fullAddress[0].text }}
+  country: {{ applicant.countryCode }}
+  phone: {{ applicant.contact.phone }}
+  fax: {{ applicant.contact.fax }}
+  email: {{ applicant.contact.email }}
+{% endfor %}
+{% for representative in representatives %}
+representative:
+  name: {{ representative.fullName[0].text }}
+  address: {{ representative.fullAddress[0].text }}
+  country: {{ representative.countryCode }}
+  phone: {{ representative.contact.phone }}
+  fax: {{ representative.contact.fax }}
+  email: {{ representative.contact.email }}
+{% endfor %}
+{% else %}
+{% endif %}

gbdtransformation/brands/hrtm/__init__.py

@@ -0,0 +1,3 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national'

gbdtransformation/brands/hrtm/filters.py

@@ -0,0 +1,158 @@
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+    'http://tmview.europa.eu/trademark/data',
+    'http://www.oami.europa.eu/TM-Search',
+    'http://hr.tmview.europa.eu/trademark/data'
+]
+
+def  get_entity_addr(addr):
+    if not addr: return None
+    result = ""
+    if addr.AddressStreet:
+        result+= addr.AddressStreet
+    if addr.AddressCity:
+        result+= " " + addr.AddressCity
+    if addr.AddressState:
+        result+= " " + addr.AddressState
+    if addr.AddressPostcode:
+        result+= " " + addr.AddressPostcode
+    return result.strip()
+
+def create_full_name(name): 
+    result = ""
+    
+    if name.FirstName: 
+        result += name.FirstName + " "
+    if name.LastName:
+        result += name.LastName
+    if name.OrganizationName and name.OrganizationName != name.LastName and name.OrganizationName != result:
+        if name.FirstName or name.LastName:
+            result += ", "
+        result += name.OrganizationName
+    return result
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+def translate_kind(kind):
+    if not kind: return ['Individual']
+
+    if kind == 'Individual': return ['Individual']
+    if kind == 'Collective': return ['Collective']
+    if kind == 'Guarantee': return ['Collective']
+
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+def translate_status(status):
+    if not status: return 'Unknown'
+
+    if status == 'Registered': return 'Registered'
+
+    if status in ['Application published',
+                  'Application filed',
+                  'Application opposed',
+                  'Filed']:
+        return 'Pending'
+
+    if status in ['Expired']:
+        return 'Expired'
+
+    if status in ['Ended']:
+        return 'Ended'
+
+    return 'Unknown'
+    #raise Exception('Status "%s" unmapped' % status)
+
+def get_termination(value, gbd_status):
+    if gbd_status == 'Ended':
+        return value
+    return None
+
+def translate_feature(feature):
+    """translation of mark feature"""
+
+    # needed information from office
+    # if office cannot provide information, then agree on a way to guess (uatm)
+    if not feature: return 'Undefined'
+    feature = feature.upper()
+    if feature == 'COMBINED': return 'Combined'
+    if feature == 'WORD': return 'Word'
+    if feature == 'STYLIZED_CHARACTERS': return 'Stylized characters'
+    if feature == 'FIGURATIVE': return 'Figurative'
+    if feature == 'SOUND': return 'Sound'
+    if feature == ' 3 d': return 'Three dimensional'
+    if feature == '3-d': return 'Three dimensional'
+    if feature == '_3_D': return 'Three dimensional'
+    if feature == '3-D': return 'Three dimensional'
+    return feature.lower().capitalize()
+    # raise Exception to recognize unmapped values
+    raise Exception('Feature "%s" unmapped' % feature)
+
+def get_registration_nb(trademark, tmstatus):
+    if "RegistrationNumber" in trademark and trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    # default registration number to application number
+    # in case none is provided
+    if tmstatus in ['Registered', 'Expired']:
+        return trademark.ApplicationNumber
+
+# -----------------------
+# filtering empty tags
+# -----------------------
+def get_goods_services(goods_services):
+    nc_gs = {} # classified
+    if not goods_services:
+        goods_services = []
+
+    if not isinstance(goods_services, list):
+        goods_services = [goods_services]
+
+    for goods_service in goods_services:
+        code = goods_service.ClassNumber
+        if code and not code == '0':
+            nc_gs[code] = {}
+            desc = goods_service.GoodsServicesDescription
+
+            if hasattr(desc, '__value'):
+                terms = desc.__value
+            else:
+                terms = desc
+
+            if terms:
+                nc_gs[code]['terms'] = terms
+            else:
+                continue
+
+            if hasattr(desc, '_languageCode'):
+                lang = desc._languageCode
+                nc_gs[code]['lang'] = lang.lower()
+
+    return nc_gs
+
+def clean_app_reg_number(app_num):
+    if app_num == None:
+        return None
+    if not app_num[:1].isdigit():
+        app_num = app_num[1:]
+    return app_num
+
+def get_publication_date(publications):
+    # in the publication information, in case:
+    # PublicationSection == "Registration"
+    # the associated PublicationDate is the publicationDate
+    if publications == None:
+        return None
+    if isinstance(publications, list):
+        for publication in publications:
+            if 'PublicationSection' in publication and publication['PublicationSection'] == 'Registration':
+                if 'PublicationDate' in publication:
+                    return publication['PublicationDate']
+    else:
+        if "Publication" in publications:
+            publication = publications["Publication"]
+            if 'PublicationSection' in publication and publication['PublicationSection'] == 'Registration':
+                if 'PublicationDate' in publication:
+                    return publication['PublicationDate']
+    return None

gbdtransformation/brands/hrtm/schema

@@ -0,0 +1,43 @@
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkDetails
+__________/TradeMark
+____________/ApplicantDetails
+______________/Applicant
+________________/ApplicantAddressBook
+__________________/FormattedNameAddress
+____________________/Name
+______________________/FreeFormatName
+________________________/FreeFormatNameDetails
+__________________________/FreeFormatNameLine
+________________/ApplicantURI
+____________/ApplicationDate
+____________/ApplicationNumber
+____________/GoodsServicesDetails
+______________/GoodsServices
+________________/ClassDescriptionDetails
+__________________/ClassDescription
+____________________/ClassNumber
+____________/MarkCurrentStatusCode
+____________/MarkFeature
+____________/MarkImageDetails
+______________/MarkImage
+________________/MarkImageCategory
+__________________/CategoryCodeDetails
+____________________/CategoryCode
+________________/MarkImageURI
+____________/OppositionPeriodEndDate
+____________/OppositionPeriodStartDate
+____________/RegistrationOfficeCode
+____________/TradeMarkURI
+____________/WordMarkSpecification
+______________/MarkVerbalElementText
+__________/TradeMark[@operationCode=Insert]
+______/TransactionIdentifier
+__/TransactionHeader
+____/SenderDetails
+______/RequestProducerDateTime
+______/TM-Search TM-Search-TradeMarkList-V1-8.xsd]

gbdtransformation/brands/hrtm/template.yml

@@ -0,0 +1,205 @@
+{% from 'navigation.tmpl' import match %}
+
+{% set TradeMark = Transaction.TradeMarkTransactionBody.TransactionContentDetails.TransactionData.TradeMarkDetails.TradeMark %}
+{% set status = TradeMark.MarkCurrentStatusCode | translate_status %}
+
+st13: {{ TradeMark.ApplicationNumber | clean_app_reg_number | st13('HR', appdate=TradeMark.ApplicationDate) }}
+gbdStatus: {{ status }}
+registrationOfficeCode: {{ TradeMark.RegistrationOfficeCode }}
+type: TRADEMARK
+
+{% if not status == 'Delete' %}
+kind: {{ TradeMark.KindMark | translate_kind }}
+markFeature: {{ TradeMark.MarkFeature | translate_feature }}
+designatedCountries:
+  - {{ TradeMark.RegistrationOfficeCode }}
+applicationNumber: {{ TradeMark.ApplicationNumber }}
+applicationDate: {{ TradeMark.ApplicationDate | convertdate('%Y-%m-%d') }}
+registrationNumber: {{ TradeMark | get_registration_nb(TradeMark.MarkCurrentStatusCode) }}
+registrationDate: {{ TradeMark.RegistrationDate }}
+applicationLanguageCode: {{ TradeMark.ApplicationLanguageCode }}
+officeStatus: {{ TradeMark.MarkCurrentStatusCode }}
+statusDate: {{ TradeMark.MarkCurrentStatusDate | convertdate('%Y-%m-%d') }}
+
+publicationDate: {{ TradeMark.PublicationDetails | get_publication_date | convertdate('%Y-%m-%d')}}
+
+expiryDate: {{ TradeMark.ExpiryDate | convertdate('%Y-%m-%d') }}
+
+markDisclaimerDetails:
+  {% call(desc) match('MarkDisclaimerDetails.MarkDisclaimer', TradeMark) %}
+  - text: {{ desc }}
+    languageCode: {{ desc | guess_language(TradeMark.ApplicationLanguageCode) }}
+  {% endcall %}
+
+markDescriptionDetails:
+  {% call(desc) match('MarkDisclaimerDetails.MarkDisclaimer', TradeMark) %}
+  - text: {{ desc }}
+    languageCode: {{ desc | guess_language(TradeMark.ApplicationLanguageCode) }}
+  {% endcall %}
+
+wordMarkSpecification:
+  markVerbalElement:
+    {% call(desc) match('WordMarkSpecification.MarkVerbalElementText', TradeMark) %}
+    - text: {{ desc }}
+      languageCode: {{ desc | guess_language(TradeMark.ApplicationLanguageCode) }}
+    {% endcall %}
+
+markImageDetails:
+  {% call(img) match('MarkImageDetails.MarkImage', TradeMark) %}
+  - name: {{ img.MarkImageURI }}
+    colourIndicator: {{ img.MarkImageColourClaimedText | get_true_or_false }}
+    colourClaimed:
+      {% call(desc) match('MarkImageColourClaimedText', img) %}
+      - text: {{ desc }}
+        languageCode: {{ desc | guess_language(TradeMark.ApplicationLanguageCode) }}
+      {% endcall %}
+    classification:
+      kind: Vienna
+      code:
+      {% call(code) match('MarkImageCategory.CategoryCodeDetails.CategoryCode', img) %}
+      - {{ code }}
+      {% endcall %}
+  {% endcall %}
+
+markSoundDetails:
+  {% call(sound) match('MarkSoundDetails.MarkSound', TradeMark) %}
+  - filename: {{ sound.MarkSoundFilename }}
+    fileformat: {{ sound.MarkSoundFileFormat }}
+  {% endcall %}
+
+markVideoDetails:
+  {% call(video) match('MarkVideoDetails.MarkVideo', TradeMark) %}
+  - filename: {{ video.MarkVideoFilename }}
+    fileformat: {{ video.MarkVideoFileFormat }}
+  {% endcall %}
+
+{% set nc_gs = TradeMark.GoodsServicesDetails.GoodsServices.ClassDescriptionDetails.ClassDescription | get_goods_services %}
+{% if (nc_gs.keys() | length) > 0 %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+    {% for nc in nc_gs.keys() %}
+    - code: {{ nc | int }}
+      {% if nc_gs[nc]['terms'] %}
+      terms:
+        {{ nc_gs[nc]['terms'] | guess_language(nc_gs[nc]['lang'], TradeMark.ApplicationLanguageCode) | field_name}}:
+        {% for gsline in nc_gs[nc]['terms'] | remove_trailing('.', '-') | split_terms %}
+          - {{ gsline | lower }}
+        {% endfor %}
+      {% endif %}
+    {% endfor %}
+{% endif %}
+
+priorities:
+  {% call(priority) match('PriorityDetails.Priority', TradeMark) %}
+  - countryCode: {{ priority.PriorityCountryCode }}
+    number: {{ priority.PriorityNumber }}
+    date: {{ priority.PriorityDate }}
+  {% endcall %}
+
+publications:
+  {% call(publication) match('PublicationDetails.Publication', TradeMark) %}
+  - identifier: {{ publication.PublicationIdentifier }}
+    date: {{ publication.PublicationDate }}
+    section: {{ publication.PublicationSection }}
+  {% endcall %}
+
+applicants:
+  {% call(Applicant) match('ApplicantDetails.Applicant', TradeMark) %}
+  - identifier: {{ Applicant.ApplicantURI }}
+    kind: {{ Applicant.ApplicantLegalEntity}}
+    fullName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName', Applicant.ApplicantAddressBook) %}
+      - text: {{ nameline | create_full_name }}
+        languageCode: {{ nameline.LastName | guess_language('en') }}
+      {% endcall %}
+    firstName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.FirstName', Applicant.ApplicantAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}
+    lastName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.LastName', Applicant.ApplicantAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}
+    middleName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.MiddleName', Applicant.ApplicantAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}
+    organizationName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.OrganizationName', Applicant.ApplicantAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}
+    fullAddress:
+      {% call(adrline) match('FormattedNameAddress.Address.FormattedAddress', Applicant.ApplicantAddressBook) %}
+      - text: {{ adrline | get_entity_addr }}
+        languageCode: {{ nameline | guess_language('en') }}
+      {% endcall %}
+    detailedAddress:
+      - languageCode: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressStreet | guess_language('en') }}
+        text: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressStreet }}
+        cityName: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressCity }}
+        geographicRegionName: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressState }}
+        postalCode: {{ Applicant.ApplicantAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressPostcode }}
+    {% call(adrline) match('FormattedNameAddress.Address', Applicant.ApplicantAddressBook) %}
+    countryCode: {{ adrline.AddressCountryCode }}
+    {% endcall %}
+  {% endcall %}
+
+representatives:
+  {% call(Representative) match('RepresentativeDetails.Representative', TradeMark) %}
+  {% if not Representative.RepresentativeIdentifier.endswith('-null') %}
+  - identifier: {{ Representative.RepresentativeURI }}
+    kind: {{ Representative.RepresentativeLegalEntity}}
+    fullName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName', Representative.RepresentativeAddressBook) %}
+      - text: {{ nameline | create_full_name }}
+        languageCode: {{ nameline.LastName | guess_language('en') }}
+      {% endcall %}
+    firstName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.FirstName', Representative.RepresentativeAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}  
+    lastName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.LastName', Representative.RepresentativeAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}    
+    middleName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.MiddleName', Representative.RepresentativeAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}  
+    organizationName:
+      {% call(nameline) match('FormattedNameAddress.Name.FormattedName.OrganizationName', Representative.RepresentativeAddressBook) %}
+      - languageCode: {{ nameline | guess_language('en') }}
+        text: {{ nameline }}
+      {% endcall %}  
+    fullAddress:
+      {% call(adrline) match('FormattedNameAddress.Address.FormattedAddress', Representative.RepresentativeAddressBook) %}
+      - text: {{ adrline | get_entity_addr}}
+        languageCode: {{ adrline | guess_language('en') }}
+      {% endcall %}
+    detailedAddress:
+      - languageCode: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressStreet | guess_language('en') }}
+        text: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressStreet }}
+        cityName: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressCity }}
+        geographicRegionName: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressState }}
+        postalCode: {{ Representative.RepresentativeAddressBook.FormattedNameAddress.Address.FormattedAddress.AddressPostcode }}
+    {% call(adrline) match('FormattedNameAddress.Address', Representative.RepresentativeAddressBook) %}
+    countryCode: {{ adrline.AddressCountryCode }}
+    {% endcall %}
+  {% endif %}
+  {% endcall %}
+
+# here goes extra information that is office specific and that is pertinent for us to retain.
+extra:
+  oppositionPeriodStartDate: {{ TradeMark.OppositionPeriodStartDate | convertdate('%Y-%m-%d') }}
+  oppositionPeriodEndDate: {{ TradeMark.OppositionPeriodEndDate | convertdate('%Y-%m-%d') }}
+
+{% endif %}

gbdtransformation/brands/idtm/__init__.py

@@ -0,0 +1,12 @@
+render = 'JSON'
+source = 'national'
+
+# M0020191466446
+# M0020191466446-11
+# D002009034362
+# JID2019045707
+appnum_mask = [ 'M00\\d{4}(\\d*)',
+                'M00\\d{4}(\\d*)-(\\d*)',
+                'M00\\d{4}(\\d*)_?([A-Z])',
+                'M00\\d{4}(\\d*)-([A-Z])',
+                '(\\w{3})\\d{4}(\\d*)' ]