fix(Verify): Correct field names

ideal-postcodes · May 14, 2024 · b1b52fe · b1b52fe
1 parent 5727941
commit b1b52fe
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 34 deletions.
diff --git a/dist/openapi.json b/dist/openapi.json
@@ -9492,28 +9492,29 @@
           "count",
           "fit",
           "confidence",
-          "address1",
-          "address2",
+          "address_line_one",
+          "address_line_two",
           "city",
           "state",
-          "zip_code"
+          "zip_code",
+          "iso_country_2"
         ],
         "properties": {
           "query": {
             "type": "string",
-            "description": "Originally submitted query"
+            "description": "Submitted query"
           },
           "query_city": {
             "type": "string",
-            "description": "Originally submitted city. If not provided this may be inferred from the query"
+            "description": "Submitted city"
           },
           "query_state": {
             "type": "string",
-            "description": "Originally submitted state. If not provided this may be inferred from the query"
+            "description": "Submitted state"
           },
           "query_zip_code": {
             "type": "string",
-            "description": "Originally submitted zip_code. If not provided this may be inferred from the query"
+            "description": "Submitted zip_code"
           },
           "match": {
             "description": "Nearest matching address",
@@ -9556,12 +9557,12 @@
             "minimum": 0,
             "description": "A confidence score represented as number between 1 and 0. 1 indicates a full match. 0 indicates no complete matching elements.\n"
           },
-          "address1": {
+          "address_line_one": {
             "type": "string",
             "description": "Primary delivery address\n",
             "example": "123 Main St"
           },
-          "address2": {
+          "address_line_two": {
             "type": "string",
             "description": "Secondary address information\n",
             "example": ""
@@ -9580,6 +9581,11 @@
             "type": "string",
             "description": "Zip code\n",
             "example": "81073-1119"
+          },
+          "iso_country_2": {
+            "type": "string",
+            "description": "2 letter ISO country code\n",
+            "example": "US"
           }
         }
       },
@@ -9595,11 +9601,12 @@
           "count",
           "fit",
           "confidence",
-          "address1",
-          "address2",
+          "address_line_one",
+          "address_line_two",
           "city",
           "state",
-          "zip_code"
+          "zip_code",
+          "iso_country_2"
         ],
         "properties": {
           "query": {
@@ -9649,14 +9656,14 @@
               0
             ]
           },
-          "address1": {
+          "address_line_one": {
             "type": "string",
             "description": "Empty if no match\n",
             "enum": [
               ""
             ]
           },
-          "address2": {
+          "address_line_two": {
             "type": "string",
             "description": "Empty if no match\n",
             "enum": [
@@ -9683,6 +9690,13 @@
             "enum": [
               ""
             ]
+          },
+          "iso_country_2": {
+            "type": "string",
+            "description": "Empty if no match\n",
+            "enum": [
+              ""
+            ]
           }
         }
       },

diff --git a/dist/openapi.yaml b/dist/openapi.yaml
@@ -8303,24 +8303,25 @@ components:
         - count
         - fit
         - confidence
-        - address1
-        - address2
+        - address_line_one
+        - address_line_two
         - city
         - state
         - zip_code
+        - iso_country_2
       properties:
         query:
           type: string
-          description: Originally submitted query
+          description: Submitted query
         query_city:
           type: string
-          description: Originally submitted city. If not provided this may be inferred from the query
+          description: Submitted city
         query_state:
           type: string
-          description: Originally submitted state. If not provided this may be inferred from the query
+          description: Submitted state
         query_zip_code:
           type: string
-          description: Originally submitted zip_code. If not provided this may be inferred from the query
+          description: Submitted zip_code
         match:
           description: Nearest matching address
           oneOf:
@@ -8348,12 +8349,12 @@ components:
           minimum: 0
           description: |
             A confidence score represented as number between 1 and 0. 1 indicates a full match. 0 indicates no complete matching elements.
-        address1:
+        address_line_one:
           type: string
           description: |
             Primary delivery address
           example: 123 Main St
-        address2:
+        address_line_two:
           type: string
           description: |
             Secondary address information
@@ -8373,6 +8374,11 @@ components:
           description: |
             Zip code
           example: 81073-1119
+        iso_country_2:
+          type: string
+          description: |
+            2 letter ISO country code
+          example: US
     UsaVerifyNoMatch:
       type: object
       title: No Address Match
@@ -8385,11 +8391,12 @@ components:
         - count
         - fit
         - confidence
-        - address1
-        - address2
+        - address_line_one
+        - address_line_two
         - city
         - state
         - zip_code
+        - iso_country_2
       properties:
         query:
           type: string
@@ -8426,13 +8433,13 @@ components:
           description: ''
           enum:
             - 0
-        address1:
+        address_line_one:
           type: string
           description: |
             Empty if no match
           enum:
             - ''
-        address2:
+        address_line_two:
           type: string
           description: |
             Empty if no match
@@ -8456,6 +8463,12 @@ components:
             Empty if no match
           enum:
             - ''
+        iso_country_2:
+          type: string
+          description: |
+            Empty if no match
+          enum:
+            - ''
     VerifyResponse:
       title: Address Verify Response
       type: object

diff --git a/openapi.ts b/openapi.ts
@@ -4952,13 +4952,13 @@ export interface components {
     };
     /** Address Match */
     UsaVerifyMatch: {
-      /** @description Originally submitted query */
+      /** @description Submitted query */
       query: string;
-      /** @description Originally submitted city. If not provided this may be inferred from the query */
+      /** @description Submitted city */
       query_city: string;
-      /** @description Originally submitted state. If not provided this may be inferred from the query */
+      /** @description Submitted state */
       query_state: string;
-      /** @description Originally submitted zip_code. If not provided this may be inferred from the query */
+      /** @description Submitted zip_code */
       query_zip_code: string;
       /** @description Nearest matching address */
       match:
@@ -4979,13 +4979,13 @@ export interface components {
        *
        * @example 123 Main St
        */
-      address1: string;
+      address_line_one: string;
       /**
        * @description Secondary address information
        *
        * @example
        */
-      address2: string;
+      address_line_two: string;
       /**
        * @description City name
        *
@@ -5004,6 +5004,12 @@ export interface components {
        * @example 81073-1119
        */
       zip_code: string;
+      /**
+       * @description 2 letter ISO country code
+       *
+       * @example US
+       */
+      iso_country_2: string;
     };
     /** No Address Match */
     UsaVerifyNoMatch: {
@@ -5037,13 +5043,13 @@ export interface components {
        *
        * @enum {string}
        */
-      address1: "";
+      address_line_one: "";
       /**
        * @description Empty if no match
        *
        * @enum {string}
        */
-      address2: "";
+      address_line_two: "";
       /**
        * @description Empty if no match
        *
@@ -5062,6 +5068,12 @@ export interface components {
        * @enum {string}
        */
       zip_code: "";
+      /**
+       * @description Empty if no match
+       *
+       * @enum {string}
+       */
+      iso_country_2: "";
     };
     /** Address Verify Response */
     VerifyResponse: {