Update documentation for the Name object (#68)

* v1.0.5

* Update documentation for the Name object

* Additional changlelog updates

CHANGELOG.md

@@ -5,6 +5,18 @@ 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.0.6] - 2022-09-16
+
+### Updated
+
+- Fixed documentation for name objects #67
+
+## [1.0.5] - 2022-09-16
+
+### Updated
+
+- Failed to include the /dist folder in the previous NPM publish
+
 ## [1.0.4] - 2022-08-30
 
 ### Updated

docs/output/accounts.md

@@ -419,6 +419,21 @@ A token that can then be used to accept Moov's Terms of Service. Must be generat
 
 
 
+### Name
+
+A person's name.
+
+**Properties**
+
+| Property | Type | Description |
+| ---- | ---- | ----------- |
+  | firstName | `string`|  |
+  | middleName | `string`|  |
+  | lastName | `string`|  |
+  | suffix | `string`|  |
+
+
+
 ### Profile
 
 Profile for a Moov acocunt. May be business or individual.
@@ -463,7 +478,7 @@ Describes the individual associated with a non-business account.
 
 | Property | Type | Description |
 | ---- | ---- | ----------- |
-  | name | `string`|  |
+  | name | [Name](#name)|  |
   | phone | [Phone](#phone)|  |
   | email | `string`|  |
   | address | [Address](#address)|  |
@@ -507,7 +522,7 @@ Describes an individual who represents a business account.
 
 | Property | Type | Description |
 | ---- | ---- | ----------- |
-  | name | `string`|  |
+  | name | [Name](#name)|  |
   | phone | [Phone](#phone)|  |
   | email | `string`|  |
   | address | [Address](#address)|  |
@@ -606,7 +621,7 @@ Describes customer support contact information for a business account.
 
 | Property | Type | Description |
 | ---- | ---- | ----------- |
-  | name | `string`| If provided, this query will attempt to find matches (including partial) against the following Account and Profile fields: Account `displayName`, Individual Profile `firstName`, `middleName`, `lastName`, and `suffix`, and Business Profile `legalBusinessName`, and `doingBusinessAs` |
+  | name | [Name](#name)| If provided, this query will attempt to find matches (including partial) against the following Account and Profile fields: Account `displayName`, Individual Profile `firstName`, `middleName`, `lastName`, and `suffix`, and Business Profile `legalBusinessName`, and `doingBusinessAs` |
   | email | `string`| Filter connected accounts by email address. It is not necessary to provided the full email address as partial matches will also be returned. |
   | type | `individual`,  `business`| Filter connected accounts by AccountType. If the `type` parameter is used in combination with name, only the corresponding type's `name` fields will be searched. For example, if `type=business` and `name=moov`, the search will attempt to find matches against the display name and Business Profile name fields (`legalBusinessName`, and `doingBusinessAs`). |
   | foreignID | `string`| Serves as an optional alias from a foreign/external system which can be used to reference this resource |

lib/accounts.js

@@ -210,6 +210,16 @@ import { Address } from "./address.js";
  * @tag Accounts
  */
 
+/**
+ * A person's name.
+ * @typedef Name
+ * @property {string} firstName
+ * @property {string} middleName
+ * @property {string} lastName
+ * @property {string} suffix
+ * @tag Accounts
+ */
+
 /**
  * Profile for a Moov acocunt. May be business or individual.
  * @typedef Profile
@@ -239,7 +249,7 @@ import { Address } from "./address.js";
 /**
  * Describes the individual associated with a non-business account.
  * @typedef IndividualProfile
- * @property {string} name
+ * @property {Name} name
  * @property {Phone} phone
  * @property {string} email
  * @property {Address} address
@@ -267,7 +277,7 @@ import { Address } from "./address.js";
 /**
  * Describes an individual who represents a business account.
  * @typedef Representative
- * @property {string} name
+ * @property {Name} name
  * @property {Phone} phone
  * @property {string} email
  * @property {Address} address
@@ -327,7 +337,7 @@ import { Address } from "./address.js";
 
 /**
  * @typedef AccountListCriteria
- * @property {string} name - If provided, this query will attempt to find matches (including partial) against the following Account and Profile fields: Account `displayName`, Individual Profile `firstName`, `middleName`, `lastName`, and `suffix`, and Business Profile `legalBusinessName`, and `doingBusinessAs`
+ * @property {Name} name - If provided, this query will attempt to find matches (including partial) against the following Account and Profile fields: Account `displayName`, Individual Profile `firstName`, `middleName`, `lastName`, and `suffix`, and Business Profile `legalBusinessName`, and `doingBusinessAs`
  * @property {string} email - Filter connected accounts by email address. It is not necessary to provided the full email address as partial matches will also be returned.
  * @property {"individual"|"business"} type - Filter connected accounts by AccountType. If the `type` parameter is used in combination with name, only the corresponding type's `name` fields will be searched. For example, if `type=business` and `name=moov`, the search will attempt to find matches against the display name and Business Profile name fields (`legalBusinessName`, and `doingBusinessAs`).
  * @property {string} foreignID - Serves as an optional alias from a foreign/external system which can be used to reference this resource

lib/types/accounts.d.ts

@@ -202,6 +202,15 @@
  * @property {string} token - An encrypted value used to record acceptance of Moov's Terms of Service
  * @tag Accounts
  */
+/**
+ * A person's name.
+ * @typedef Name
+ * @property {string} firstName
+ * @property {string} middleName
+ * @property {string} lastName
+ * @property {string} suffix
+ * @tag Accounts
+ */
 /**
  * Profile for a Moov acocunt. May be business or individual.
  * @typedef Profile
@@ -229,7 +238,7 @@
 /**
  * Describes the individual associated with a non-business account.
  * @typedef IndividualProfile
- * @property {string} name
+ * @property {Name} name
  * @property {Phone} phone
  * @property {string} email
  * @property {Address} address
@@ -254,7 +263,7 @@
 /**
  * Describes an individual who represents a business account.
  * @typedef Representative
- * @property {string} name
+ * @property {Name} name
  * @property {Phone} phone
  * @property {string} email
  * @property {Address} address
@@ -279,6 +288,7 @@
  * Describes the verification state of an account
  * @typedef AccountVerification
  * @property {"unverified"|"pending"|"resubmit"|"review"|"verified"|"failed"} verificationStatus - The status of an identity verification for a profile
+ * @tag Accounts
  */
 /**
  * Describes customer support contact information for a business account.
@@ -306,7 +316,7 @@
  */
 /**
  * @typedef AccountListCriteria
- * @property {string} name - If provided, this query will attempt to find matches (including partial) against the following Account and Profile fields: Account `displayName`, Individual Profile `firstName`, `middleName`, `lastName`, and `suffix`, and Business Profile `legalBusinessName`, and `doingBusinessAs`
+ * @property {Name} name - If provided, this query will attempt to find matches (including partial) against the following Account and Profile fields: Account `displayName`, Individual Profile `firstName`, `middleName`, `lastName`, and `suffix`, and Business Profile `legalBusinessName`, and `doingBusinessAs`
  * @property {string} email - Filter connected accounts by email address. It is not necessary to provided the full email address as partial matches will also be returned.
  * @property {"individual"|"business"} type - Filter connected accounts by AccountType. If the `type` parameter is used in combination with name, only the corresponding type's `name` fields will be searched. For example, if `type=business` and `name=moov`, the search will attempt to find matches against the display name and Business Profile name fields (`legalBusinessName`, and `doingBusinessAs`).
  * @property {string} foreignID - Serves as an optional alias from a foreign/external system which can be used to reference this resource
@@ -471,6 +481,15 @@ export type TermsOfServiceToken = {
      */
     token: string;
 };
+/**
+ * A person's name.
+ */
+export type Name = {
+    firstName: string;
+    middleName: string;
+    lastName: string;
+    suffix: string;
+};
 /**
  * Profile for a Moov acocunt. May be business or individual.
  */
@@ -505,7 +524,7 @@ export type BusinessProfile = {
  * Describes the individual associated with a non-business account.
  */
 export type IndividualProfile = {
-    name: string;
+    name: Name;
     phone: Phone;
     email: string;
     address: Address;
@@ -540,7 +559,7 @@ export type IndustryCodes = {
  * Describes an individual who represents a business account.
  */
 export type Representative = {
-    name: string;
+    name: Name;
     phone: Phone;
     email: string;
     address: Address;
@@ -615,7 +634,7 @@ export type AccountListCriteria = {
     /**
      * - If provided, this query will attempt to find matches (including partial) against the following Account and Profile fields: Account `displayName`, Individual Profile `firstName`, `middleName`, `lastName`, and `suffix`, and Business Profile `legalBusinessName`, and `doingBusinessAs`
      */
-    name: string;
+    name: Name;
     /**
      * - Filter connected accounts by email address. It is not necessary to provided the full email address as partial matches will also be returned.
      */

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@moovio/node",
-    "version": "1.0.4",
+    "version": "1.0.5",
     "description": "Node SDK for the Moov API and Dashboard",
     "module": "dist/mjs/index.js",
     "main": "dist/cjs/index.js",