CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.6.0] - 2023-04-21
+
+### Added
+
+- Add UNACTIVATED state to card model.
+- Add `refresh` action to /cards endpoint.
+
+### Fixed
+
+- Correctly defined CardIdentifier separate from CardIdentifierSummary.
+
 ## [1.5.0] - 2023-04-21
 
 ### Added

Dockerfile

 # This Dockerfile is just used for testing purposes and therefore builds in tox
 # to the image.
 
-FROM openapitools/openapi-generator-cli as builder
+FROM openapitools/openapi-generator-cli:v6.5.0 as builder
 
 WORKDIR /generated
 

setup.py

@@ -8,7 +8,7 @@ PACKAGE_DESCRIPTION = (
     "A module containing helpers and shared code related to identity systems within UIS, "
     "University of Cambridge."
 )
-PACKAGE_VERSION = "1.5.0"
+PACKAGE_VERSION = "1.6.0"
 PACKAGE_URL = "https://gitlab.developers.cam.ac.uk/uis/devops/iam/identity-lib"
 
 

specs/card.sha

-f095fe5713abb02bfa6a209036ca494dce5e50d2
\ No newline at end of file
+2b6b019c57a3af9bc60850db2be800b2a6b84ddc
\ No newline at end of file

specs/card.yaml

@@ -74,7 +74,7 @@ definitions:
         type: string
       identifiers:
         items:
-          $ref: '#/definitions/CardIdentifier'
+          $ref: '#/definitions/CardIdentifierSummary'
         type: array
       issueNumber:
         description: The issue number of the card
@@ -116,6 +116,7 @@ definitions:
           - REVOKED
           - RETURNED
           - EXPIRED
+          - UNACTIVATED
         title: Status
         type: string
       updatedAt:
@@ -132,6 +133,84 @@ definitions:
       - notes
     type: object
   CardIdentifier:
+    properties:
+      allowedActions:
+        readOnly: true
+        title: Allowed actions
+        type: string
+      cardRequests:
+        description: Card requests identified by this identifier
+        items:
+          description: Card requests identified by this identifier
+          format: uuid
+          type: string
+        type: array
+        uniqueItems: true
+      cards:
+        description: Cards identified by this identifier
+        items:
+          description: Cards identified by this identifier
+          format: uuid
+          type: string
+        type: array
+        uniqueItems: true
+      deletedAt:
+        format: date-time
+        title: Deleted at
+        type: string
+        x-nullable: true
+      id:
+        format: uuid
+        readOnly: true
+        title: Id
+        type: string
+      isDeleted:
+        title: Is deleted
+        type: boolean
+      isHighestPrimaryIdentifier:
+        description: Card identifier is highest primary identifier
+        title: Primary
+        type: boolean
+      relatedIdentifiers:
+        items:
+          $ref: '#/definitions/CardIdentifierSummary'
+        type: array
+      retainUntil:
+        description: If non-NULL, the minimum period the record should be retained
+        format: date-time
+        title: Retain until
+        type: string
+        x-nullable: true
+      scheme:
+        description: The identifier's scheme
+        enum:
+          - v1.person.identifiers.cam.ac.uk
+          - person.v1.student-records.university.identifiers.cam.ac.uk
+          - person.v1.human-resources.university.identifiers.cam.ac.uk
+          - person.v1.board-of-graduate-studies.university.identifiers.cam.ac.uk
+          - person.v1.legacy-card.university.identifiers.cam.ac.uk
+          - mifare-identifier.v1.card.university.identifiers.cam.ac.uk
+          - mifare-number.v1.card.university.identifiers.cam.ac.uk
+          - card.v1.legacy-card.university.identifiers.cam.ac.uk
+          - temporary-card.v1.card.university.identifiers.cam.ac.uk
+          - photo.v1.photo.university.identifiers.cam.ac.uk
+          - barcode.v1.card.university.identifiers.cam.ac.uk
+          - institution.v1.legacy-card.university.identifiers.cam.ac.uk
+        title: Scheme
+        type: string
+      value:
+        description: The identifier's value
+        minLength: 1
+        title: Value
+        type: string
+    required:
+      - scheme
+      - value
+      - cards
+      - cardRequests
+      - relatedIdentifiers
+    type: object
+  CardIdentifierSummary:
     properties:
       id:
         format: uuid
@@ -358,7 +437,7 @@ definitions:
         type: string
       identifiers:
         items:
-          $ref: '#/definitions/CardIdentifier'
+          $ref: '#/definitions/CardIdentifierSummary'
         type: array
       issueNumber:
         description: The issue number of the card
@@ -530,7 +609,7 @@ definitions:
         type: string
       identifiers:
         items:
-          $ref: '#/definitions/CardIdentifier'
+          $ref: '#/definitions/CardIdentifierSummary'
         type: array
       issueNumber:
         description: The issue number of the card
@@ -613,7 +692,7 @@ definitions:
         type: string
       identifiers:
         items:
-          $ref: '#/definitions/CardIdentifier'
+          $ref: '#/definitions/CardIdentifierSummary'
         type: array
       issueNumber:
         description: The issue number of the card
@@ -651,6 +730,7 @@ definitions:
           - REVOKED
           - RETURNED
           - EXPIRED
+          - UNACTIVATED
         title: Status
         type: string
       updatedAt:
@@ -1127,6 +1207,11 @@ paths:
           in: query
           name: is_highest_primary_identifier
           type: boolean
+        - description: Filter isDeleted
+          format: boolean
+          in: query
+          name: is_deleted
+          type: boolean
         - description: The pagination cursor value.
           in: query
           name: cursor
@@ -1154,11 +1239,11 @@ paths:
                 x-nullable: true
               results:
                 items:
-                  $ref: '#/definitions/CardIdentifier'
+                  $ref: '#/definitions/CardIdentifierSummary'
                 type: array
             required:
               - results
-            title: PaginatedCardIdentifierType
+            title: PaginatedCardIdentifierSummaryType
             type: object
         "400":
           description: Invalid input.
@@ -2493,6 +2578,7 @@ paths:
             - REVOKED
             - RETURNED
             - EXPIRED
+            - UNACTIVATED
           in: query
           name: status
           type: string
@@ -2616,6 +2702,7 @@ paths:
                   - REVOKED
                   - RETURNED
                   - EXPIRED
+                  - UNACTIVATED
                 type: string
               updated_at__gte:
                 description: Filter updatedAt by IsoDateTime greater than
@@ -2634,6 +2721,7 @@ paths:
             - REVOKED
             - RETURNED
             - EXPIRED
+            - UNACTIVATED
           in: query
           name: status
           type: string
@@ -2751,7 +2839,9 @@ paths:
 
         This method allows a client to submit an action in the request body and optional note for a given card. The allowed action is `cancel`.
 
-        For the `cancel` action, the client can optionally append a `note` describing the reason for cancelling the card.
+        The `cancel` action cancels the card. The client can optionally append a `note` describing the reason for cancelling the card.
+
+        The `refresh` action refreshes the card state. If the card is UNACTIVATED and the cardholder does not have an ISSUED card, the card state will be updated to ISSUED.
 
         ### Permissions
 
@@ -2768,6 +2858,7 @@ paths:
                 description: The action to apply to this card.
                 enum:
                   - cancel
+                  - refresh
                 title: CardUpdateRequestActionEnum
                 type: string
               note:

specs/lookup.sha

-66f461da6081372b2db0fc1450423b324f40d38d
\ No newline at end of file
+e1605f5c03b032cfb4bf8775149c1230e4ae3c34
\ No newline at end of file

specs/lookup.yaml

@@ -3238,17 +3238,16 @@ tags:
         `schemeid` of an attribute scheme. For example to fetch a
         person's email addresses, use the value `"email"`. For people common
         attribute schemes include `"jpegPhoto"`, `"misAffiliation"`,
-        `"title"`, `"universityPhone"`, `"mobexPhone"`,
-        `"landlinePhone"`, `"mobilePhone"`, `"pager"`,
-        `"labeledURI"` and `"address"`. The full list of person
+        `"title"`, `"universityPhone"`, "landlinePhone"`, `"mobilePhone"`, 
+        ``"pager"`, `"labeledURI"` and `"address"`. The full list of person
         attribute schemes may be obtained using `#allAttributeSchemes`.
-      
+
       * **Pseudo-attributes**. Certain special pseudo-attributes are defined
         for convenience. For people, the following pseudo-attributes are supported:
       
         * `"phone_numbers"` - fetches all phone numbers. This is
           equivalent to
-          `"universityPhone,instPhone,mobexPhone,landlinePhone,mobilePhone,pager"`.
+          `"universityPhone,instPhone,landlinePhone,mobilePhone,pager"`.
       
         * `"all_identifiers"` - fetches all identifiers. Currently people
           only have CRSid identifiers, but in the future additional identifiers such