wipo-gbd-transformation 1.1.46__py3-none-any.whl → 1.1.59__py3-none-any.whl

gbdtransformation/designs/xxid/template.yml

@@ -1,143 +1,355 @@
 {% from 'navigation.tmpl' import match %}
 
-design:
-  type: # (OPEN|SEALED) -INID 27 - SealedDepositIndicator
-  designGrouping: # SINGLE|MULTIPLE
-  kind: # DESIGN|DESING PATENT(US)
-  registrationOfficeCode:
-  designatedCountries:
-    - str (CountryCode)
-  # rarely passed
-  filingPlace:
-
-  # some collections indicate that the application
-  # originates from international filing and provide IR number
-  applicationRefNumber:
-  applicationRefOrigin:
-
-  # can be deduced from appnum given office cc and (optional) appdate
-  st13: # {{ Design.ApplicationNumber | st13('XX', appdate=... }}
-
-  applicationNumber:
-  # dates can be converted if not matching expected format
-  applicationDate: # ex: {{ Design.ApplicationDate | convertdate('%Y%m%d') }}
-
-  # some collections have registration number
-  # equals application number when registered
-  registrationNumber:
-  # some collections we can guess registration date
-  # from event list
-  registrationDate:
-  publicationDate:
-  effectiveDate:
-  defermentPeriod:
-  expiryDate:
-
-  applicationLanguageCode:
-  # rarely passed
-  secondLanguageCode:
-
-  # status as is in the document
-  officeStatus:
-  # status as translated to gbdFormat
-  gbdStatus:  # (Ended|Expired|Pending|Registered|Unknown)
-  # can also be the date of the last event in markevents if given
-  statusDate:
-
-  designDescription: #Init 57
-    - languageCode:
-      text:
+type: # DESIGN
+subtype: # (OPEN|SEALED) -INID 27 - SealedDepositIndicator
+designGrouping: # SINGLE|MULTIPLE
+designsCount:
+kind:
+  - # INDUSTRIAL DESIGN|DESING PATENT(US)
+registrationOfficeCode:
+designatedCountries:
+  - str (CountryCode)
 
-  productDisclaimer:
-    - languageCode:
-      text:
+# some collections indicate that the application
+# originates from international filing and provide IR number
+reference:
+  application:
+    - number:
+      date:
+      office:
+  registration:
+    - number:
+      date:
+      office:
 
-  designImageDetails:
-    - name:
-      legend:
-          - string
-
-  applicants:
-    - identifier:
-      kind:
-      fullName:
-        - languageCode:
-          text:
-      fullAddress:
-        - languageCode:
-          text:
-      countryCode: # sometimes, country name is provided instead
-
-  representatives:
-    - identifier:
-      kind:
-      fullName:
-        - languageCode:
-          text:
-      fullAddress:
-        - languageCode:
-          text:
-      countryCode:
+# rarely passed
+filingPlace:
 
-  designer:
-    - identifier:
-      kind:
-      fullName:
-        - languageCode:
-          text:
-      fullAddress:
-        - languageCode:
-          text:
-      countryCode:
+# can be deduced from appnum given office cc and (optional) appdate, if no application number, fallback to registration number
+st13: # {{ Design.ApplicationNumber | st13(registrationNumber, 'XX', appdate=... }}
+
+applicationNumber:
+# dates can be converted if not matching expected format
+applicationDate: # ex: {{ Design.ApplicationDate | convertdate('%Y%m%d') }}
+
+# some collections have registration number
+# equals application number when registered
+registrationNumber:
+# some collections we can guess registration date
+# from event list
+registrationDate:
+
+# this is a list
+publicationDates:
+  - str (date)
+
+# for novelty search
+earliestPublicationDate:
 
-  correspondence:
+effectiveDate:
+defermentExpiryDate:
+expiryDate:
+
+applicationLanguageCode:
+# rarely passed
+secondLanguageCode:
+
+applicants:
+  - identifier:
+    kind:
     fullName:
       - languageCode:
         text:
+    firstName:
+      - languageCode:
+        text:
+    lastName:
+      - languageCode:
+        text:
+    middleName:
+      - languageCode:
+        text:
     fullAddress:
       - languageCode:
         text:
-    countryCode:
+        cityName:
+        geographicRegionName:
+        countryCode:
+        postalCode:
+    countryCode: # sometimes, country name is provided instead
+    entitlement:
+        entitlementNationalityCode: 
+        entitlementEstablishment: 
+        entitlementDomiciled:
+
+applicantsNormalized:
+  - identifier:
+    kind:
+    orgName:
+      - languageCode:
+        text:
+    firstName:
+      - languageCode:
+        text:
+    lastName:
+      - languageCode:
+        text:
+    middleName:
+      - languageCode:
+        text:
+    fullAddress:
+      - languageCode:
+        addressLine:
+        cityName:
+        geographicRegionName:
+        countryCode:
+        country:
+        postalCode:
+        postalBox: 
+    processingTool:
+      name:
+      version:
+      processingDate:
 
-  productIndicationClasses:
-    - kind: Locarno/US/CA/Etc
-      version:  #mostly
-      code:
+representatives:
+  - identifier:
+    kind:
+    fullName:
+      - languageCode:
+        text:
+    firstName:
+      - languageCode:
+        text:
+    lastName:
+      - languageCode:
+        text:
+    middleName:
+      - languageCode:
+        text:
+    fullAddress:
+      - languageCode:
+        text:
+        cityName:
+        geographicRegionName:
+        countryCode:
+        postalCode:
+    countryCode: # sometimes, country name is provided instead
 
-  productIndication:
+representativesNormalized:
+  - identifier:
+    kind:
+    orgName:
+      - languageCode:
+        text:
+    firstName:
+      - languageCode:
+        text:
+    lastName:
+      - languageCode:
+        text:
+    middleName:
+      - languageCode:
+        text:
+    fullAddress:
+      - languageCode:
+        addressLine:
+        cityName:
+        geographicRegionName:
+        countryCode:
+        country:
+        postalCode:
+        postalBox:
+    processingTool:
+      name:
+      version:
+      processingDate:
+
+correspondence:
+  fullName:
+    - languageCode:
+      text:
+  firstName:
+    - languageCode:
+      text:
+  lastName:
+    - languageCode:
+      text:
+  middleName:
+    - languageCode:
+      text:
+  fullAddress:
     - languageCode:
       text:
+      cityName:
+      geographicRegionName:
+      countryCode:
+      postalCode:
+  countryCode: # sometimes, country name is provided instead
 
-  records:
-    - identifier:
-      officeKind:
-      gbdKind:
-      officeStatus:
-      gbdStatus:
-      statusDate:
+correspondenceNormalized:
+  kind:
+  orgName:
+    - languageCode:
+      text:
+  firstName:
+    - languageCode:
+      text:
+  lastName:
+    - languageCode:
+      text:
+  middleName:
+    - languageCode:
+      text:
+  fullAddress:
+    - languageCode:
+      addressLine:
+      cityName:
+      geographicRegionName:
+      countryCode:
+      country:
+      postalCode:
+      postalBox:
+  processingTool:
+    name:
+    version:
+    processingDate:
 
-  exhibition:
-    - date:
-      name:
-      location:
+designClaim:
+  claims:
+    - languageCode:
+      claim:
+  designatedCountries:
+    - str
+  affectedDesigns:
+    allDesignsIndicator:
 
-  priorities:
-    - countryCode:
-      number:
-      date:
-      comment:
+businessEntityStatusClaim:
+  - BusinessEntityStatusCategory:
+    DesignatedCountryCode:
 
-  publications:
-    - identifier:
-      date:
-      section:
+designs:
+  - designPos:
+    # status as is in the document
+    officeStatus:
+    # status as translated to gbdFormat
+    gbdStatus:  # (Ended|Expired|Pending|Registered|Unknown)
+    # can also be the date of the last event in markevents if given
+    statusDate:
 
-  events:
-    - officeKind:
-      gbdKind: # Filed, Withdrawn, Rejected, Unknown
-      date:
-  # here goes extra information that is office specific and that is pertinent for us to retain.
-  extra:
+    productIndication:
+      - languageCode:
+        text:
+
+    designDescription: #Init 57
+      - languageCode:
+        text:
+
+    productDisclaimer:
+      - languageCode:
+        text:
+
+    designImageDetails:
+      - name:
+        rank:
+        type:
+        legends:
+          - languageCode:
+            legend:
+
+    designer:
+      - identifier:
+        kind:
+        fullName:
+          - languageCode:
+            text:
+        firstName:
+          - languageCode:
+            text:
+        lastName:
+          - languageCode:
+            text:
+        middleName:
+          - languageCode:
+            text:
+        fullAddress:
+          - languageCode:
+            text:
+            cityName:
+            geographicRegionName:
+            countryCode:
+            postalCode:
+        countryCode: # sometimes, country name is provided instead
+
+    designerNormalized:
+      - identifier:
+        kind:
+        orgName:
+          - languageCode:
+            text:
+        firstName:
+          - languageCode:
+            text:
+        lastName:
+          - languageCode:
+            text:
+        middleName:
+          - languageCode:
+            text:
+        fullAddress:
+          - languageCode:
+            addressLine:
+            cityName:
+            geographicRegionName:
+            countryCode:
+            country:
+            postalCode:
+            postalBox:
+        processingTool:
+          name:
+          version:
+          processingDate:
+
+    productIndicationClasses:
+      - kind: Locarno/US/CA/Etc
+        version:  #mostly
+        classes:
+        - code:
+
+    exhibition:
+      - date:
+        name:
+        location:
+
+    priorities:
+      - countryCode:
+        number:
+        date:
+        comment:
+        DASAccessCode:
+
+    exceptionLackNoveltyDeclaration:
+      - country:
+        legalBasis:
+
+    principalDesignRelations:
+      - principalDesignCategory:
+        documentIdentifier:
+        principalDesignReference:
+        designatedCountries:
+          - country:
+            legalBasis:
+
+    noveltyStatement:
+      - languageCode:
+        text:
+
+    publications:
+      - identifier:
+        date:
+        section:
+
+# here goes extra information that is office specific and that is pertinent for us to retain.
+extra: