@leaddreamer/inventorylogic 0.0.3-beta.38 → 0.0.3-beta.4

package/README.md

@@ -19,21 +19,10 @@ services.</p>
 <dd><p>A collection of Business logic and database functions.  Shared between ReactJS
 frontEnd and NodeJS BackEnd</p>
 </dd>
-<dt><a href="#module_Addresses">Addresses</a></dt>
-<dd><p>Types and functins for handling addresses</p>
-</dd>
-<dt><a href="#module_BusinessData">BusinessData</a></dt>
-<dd><p>Functions for managing (potentially)private data for an organization.
-Unified structure as a sub-record of organization, or CityManager accounts</p>
-</dd>
 <dt><a href="#module_Commodities">Commodities</a></dt>
 <dd><p>Typedefs, constants, support functions and database operations related to Commodity Matrials
 users</p>
 </dd>
-<dt><a href="#module_Fundamentals">Fundamentals</a></dt>
-<dd><p>Typedefs, constants, support functions and database operations related to Fundamental
-setting from the Database *</p>
-</dd>
 <dt><a href="#module_LineItem">LineItem</a></dt>
 <dd><p>Typedefs, constants, support functions and database operations related to LineItem Matrials
 users</p>
@@ -47,10 +36,6 @@ users</p>
 to an individual user.  These do not <em>particularly</em> represent a paymentProvider - they are meant
 as an abstraction above a specific payment processor.</p>
 </dd>
-<dt><a href="#module_PrivateData">PrivateData</a></dt>
-<dd><p>Functions for managing (potentially)private data for a user or organization.
-Unified structure as a sub-record of fan, organization, or CityManager accounts</p>
-</dd>
 <dt><a href="#module_Product">Product</a></dt>
 <dd><p>Typedefs, constants, support functions and database operations related to Products</p>
 </dd>
@@ -193,343 +178,6 @@ called from a cloud environment
 | measurementId: | <code>string</code> | (optional) Analytics/Measurement ID from Firebase Console |
 | mapsAPIKey | <code>string</code> | (optional) App ID for Google Maps API, from Google |
 
-<a name="module_Addresses"></a>
-
-## Addresses
-Types and functins for handling addresses
-
-
-* [Addresses](#module_Addresses)
-    * _static_
-        * [.AddressDefault](#module_Addresses.AddressDefault) : <code>AddressType</code>
-        * [.AddressForm](#module_Addresses.AddressForm) : <code>AddressType</code>
-        * [.maplink](#module_Addresses.maplink) : <code>MapLink</code>
-        * [.deleteAddress(address)](#module_Addresses.deleteAddress) ⇒ <code>Promise.&lt;void&gt;</code>
-        * [.deleteAddressByIdAndParent(addressId, parent, batch)](#module_Addresses.deleteAddressByIdAndParent) ⇒ <code>Promise.ChainType</code>
-        * [.formatAddress(address)](#module_Addresses.formatAddress) ⇒ <code>string</code>
-        * [.saveAddress(address, paraentRefPath)](#module_Addresses.saveAddress) ⇒ <code>Promise.&lt;AddressType&gt;</code>
-        * [.fetchAddresses(account)](#module_Addresses.fetchAddresses) ⇒ <code>Promise.&lt;Array.AddressType&gt;</code>
-    * _inner_
-        * [~AddressType](#module_Addresses..AddressType) : <code>object</code>
-        * [~MapLink](#module_Addresses..MapLink) : <code>object</code>
-        * [~ChainType](#module_Addresses..ChainType) : <code>WriteBatch</code> \| <code>Transaction</code> \| <code>void</code>
-
-<a name="module_Addresses.AddressDefault"></a>
-
-### Addresses.AddressDefault : <code>AddressType</code>
-**Kind**: static constant of [<code>Addresses</code>](#module_Addresses)  
-<a name="module_Addresses.AddressForm"></a>
-
-### Addresses.AddressForm : <code>AddressType</code>
-**Kind**: static constant of [<code>Addresses</code>](#module_Addresses)  
-<a name="module_Addresses.maplink"></a>
-
-### Addresses.maplink : <code>MapLink</code>
-**Kind**: static constant of [<code>Addresses</code>](#module_Addresses)  
-**Read only**: true  
-<a name="module_Addresses.deleteAddress"></a>
-
-### Addresses.deleteAddress(address) ⇒ <code>Promise.&lt;void&gt;</code>
-Deletes an existing address record from the database, based on it's own refPath
-
-**Kind**: static method of [<code>Addresses</code>](#module_Addresses)  
-
-| Param | Type |
-| --- | --- |
-| address | <code>AddressType</code> | 
-| address.refPath | <code>string</code> | 
-
-<a name="module_Addresses.deleteAddressByIdAndParent"></a>
-
-### Addresses.deleteAddressByIdAndParent(addressId, parent, batch) ⇒ <code>Promise.ChainType</code>
-Deletes an existing address record from the database, based on it's parent
-record and Id
-
-**Kind**: static method of [<code>Addresses</code>](#module_Addresses)  
-
-| Param | Type |
-| --- | --- |
-| addressId | <code>string</code> | 
-| parent | <code>OrganizationType</code> | 
-| parent.refPath | <code>string</code> | 
-| batch | <code>ChainType</code> | 
-
-<a name="module_Addresses.formatAddress"></a>
-
-### Addresses.formatAddress(address) ⇒ <code>string</code>
-Builds a formatted string from a provided address record
-
-**Kind**: static method of [<code>Addresses</code>](#module_Addresses)  
-
-| Param | Type |
-| --- | --- |
-| address | <code>AddressType</code> | 
-
-<a name="module_Addresses.saveAddress"></a>
-
-### Addresses.saveAddress(address, paraentRefPath) ⇒ <code>Promise.&lt;AddressType&gt;</code>
-Saves an address record to the database below the provided parentRefPath,
-whether exsiting or not
-
-**Kind**: static method of [<code>Addresses</code>](#module_Addresses)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| address | <code>AddressType</code> |  |
-| address.refPath | <code>string</code> | if present, writes back |
-| paraentRefPath | <code>string</code> | required if new record |
-
-<a name="module_Addresses.fetchAddresses"></a>
-
-### Addresses.fetchAddresses(account) ⇒ <code>Promise.&lt;Array.AddressType&gt;</code>
-Fetches all address records for an account
-
-**Kind**: static method of [<code>Addresses</code>](#module_Addresses)  
-
-| Param | Type |
-| --- | --- |
-| account | <code>Record</code> | 
-| account.refPath | <code>string</code> | 
-
-<a name="module_Addresses..AddressType"></a>
-
-### Addresses~AddressType : <code>object</code>
-**Kind**: inner typedef of [<code>Addresses</code>](#module_Addresses)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| Id | <code>string</code> | will be populated for existing record; null or missing for new/minimal object |
-| refPath | <code>string</code> | will be populated for existing record; null or missing for new/minimal object |
-| address_line_1 | <code>string</code> |  |
-| address_line_2 | <code>string</code> |  |
-| city | <code>string</code> |  |
-| region | <code>string</code> | selected from a list of supported Cities/Regions |
-| state | <code>string</code> |  |
-| zip | <code>zip</code> |  |
-| mapLink | <code>maplink</code> | link to Google map location |
-
-<a name="module_Addresses..MapLink"></a>
-
-### Addresses~MapLink : <code>object</code>
-**Kind**: inner typedef of [<code>Addresses</code>](#module_Addresses)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| placeId | <code>string</code> | as defined by Google |
-| latlng | <code>object</code> | coordinates tuple |
-| latlng.lat | <code>string</code> | lattitude |
-| latlng.lng | <code>string</code> | longitude |
-| url | <code>string</code> | link to place/map entry |
-| formatted_address | <code>string</code> | printable string of address |
-
-<a name="module_Addresses..ChainType"></a>
-
-### Addresses~ChainType : <code>WriteBatch</code> \| <code>Transaction</code> \| <code>void</code>
-**Kind**: inner typedef of [<code>Addresses</code>](#module_Addresses)  
-<a name="module_BusinessData"></a>
-
-## BusinessData
-Functions for managing (potentially)private data for an organization.
-Unified structure as a sub-record of organization, or CityManager accounts
-
-
-* [BusinessData](#module_BusinessData)
-    * _static_
-        * [.fetchFullAccount(account)](#module_BusinessData.fetchFullAccount) ⇒ <code>Promise.AccountType</code>
-        * [.fetchBusinessData(account)](#module_BusinessData.fetchBusinessData) ⇒ <code>Promise.BusinessData</code>
-        * [.accountPage(account, origin)](#module_BusinessData.accountPage) ⇒ <code>string</code>
-        * [.createBusinessData(account, batch)](#module_BusinessData.createBusinessData) ⇒ <code>Promise.&lt;ChainType&gt;</code>
-        * [.saveBusinessData(businessData)](#module_BusinessData.saveBusinessData) ⇒ <code>Promise.&lt;BusinessData&gt;</code>
-        * [.deleteBusinessData(businessData)](#module_BusinessData.deleteBusinessData) ⇒ <code>Promise.&lt;void&gt;</code>
-        * [.businessDataPath(account)](#module_BusinessData.businessDataPath) ⇒ <code>string</code>
-        * [.profileComplete(account, businessData)](#module_BusinessData.profileComplete) ⇒ <code>Boolean</code>
-        * [.profileIncomplete(account, businessData)](#module_BusinessData.profileIncomplete) ⇒ <code>string</code> \| <code>null</code>
-        * [.setOpenIssues(businessData)](#module_BusinessData.setOpenIssues) ⇒ <code>Promise.boolean</code>
-        * [.clearOpenIssues(businessData)](#module_BusinessData.clearOpenIssues) ⇒ <code>Promise.boolean</code>
-    * _inner_
-        * [~BusinessDefault](#module_BusinessData..BusinessDefault) : <code>BusinessData</code>
-        * [~BusinessAccountForm](#module_BusinessData..BusinessAccountForm) : <code>BusinessData</code>
-        * [~contact](#module_BusinessData..contact) : <code>object</code>
-        * [~BusinessData](#module_BusinessData..BusinessData) : <code>object</code>
-        * [~ChainType](#module_BusinessData..ChainType) : <code>WriteBatch</code> \| <code>Transaction</code> \| <code>void</code>
-
-<a name="module_BusinessData.fetchFullAccount"></a>
-
-### BusinessData.fetchFullAccount(account) ⇒ <code>Promise.AccountType</code>
-Fetches a fulll object representation of an account, including BusinessData
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-
-| Param | Type |
-| --- | --- |
-| account | <code>AccountType</code> | 
-
-<a name="module_BusinessData.fetchBusinessData"></a>
-
-### BusinessData.fetchBusinessData(account) ⇒ <code>Promise.BusinessData</code>
-Fetches the BusinessData (corporate, addresses, etc) for an account
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-
-| Param | Type |
-| --- | --- |
-| account | <code>AccountType</code> | 
-
-<a name="module_BusinessData.accountPage"></a>
-
-### BusinessData.accountPage(account, origin) ⇒ <code>string</code>
-Composes a URL for an "account page" from the account, and passed base URL
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-**Returns**: <code>string</code> - full URL for business accouont  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| account | <code>AccountType</code> |  |
-| origin | <code>string</code> | base URL for the application |
-
-<a name="module_BusinessData.createBusinessData"></a>
-
-### BusinessData.createBusinessData(account, batch) ⇒ <code>Promise.&lt;ChainType&gt;</code>
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-**Returns**: <code>Promise.&lt;ChainType&gt;</code> - WriteBatch, Transaction or Void  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| account | <code>AccountType</code> |  |
-| batch | <code>ChainType</code> | batching object.  Transaction will be added to the batch |
-
-<a name="module_BusinessData.saveBusinessData"></a>
-
-### BusinessData.saveBusinessData(businessData) ⇒ <code>Promise.&lt;BusinessData&gt;</code>
-Writes the "Business" data to the database
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-
-| Param | Type |
-| --- | --- |
-| businessData | <code>BusinessData</code> | 
-
-<a name="module_BusinessData.deleteBusinessData"></a>
-
-### BusinessData.deleteBusinessData(businessData) ⇒ <code>Promise.&lt;void&gt;</code>
-Deletes a BusinessData record (rarely used if ever)
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-
-| Param | Type |
-| --- | --- |
-| businessData | <code>BusinessData</code> | 
-| businessData.refPath | <code>string</code> | 
-
-<a name="module_BusinessData.businessDataPath"></a>
-
-### BusinessData.businessDataPath(account) ⇒ <code>string</code>
-creates the "base path" (refPath) to store addresses based on an account (refPath)
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-
-| Param | Type |
-| --- | --- |
-| account | <code>Record</code> | 
-| account.refPath | <code>string</code> | 
-
-<a name="module_BusinessData.profileComplete"></a>
-
-### BusinessData.profileComplete(account, businessData) ⇒ <code>Boolean</code>
-verifies that all needed information has been filled in
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| account | <code>AccountType</code> |  |
-| businessData | <code>BusinessData</code> | record |
-
-<a name="module_BusinessData.profileIncomplete"></a>
-
-### BusinessData.profileIncomplete(account, businessData) ⇒ <code>string</code> \| <code>null</code>
-verifies that all needed information has been filled in
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| account | <code>AccountType</code> |  |
-| businessData | <code>BusinessData</code> | record |
-
-<a name="module_BusinessData.setOpenIssues"></a>
-
-### BusinessData.setOpenIssues(businessData) ⇒ <code>Promise.boolean</code>
-Sets the "openIssues" flag in an account's BUSINESSDATA record
-The account's refPath is attached to the Payment system's record, and
-used here to find the Payment Account
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-
-| Param | Type |
-| --- | --- |
-| businessData | <code>BusinessData</code> | 
-
-<a name="module_BusinessData.clearOpenIssues"></a>
-
-### BusinessData.clearOpenIssues(businessData) ⇒ <code>Promise.boolean</code>
-Clears the "openIssues" flag in an account's BUSINESSDATA record
-The account's refPath is attached to the Payment system's record, and
-used here to find the Payment Account
-
-**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
-
-| Param | Type |
-| --- | --- |
-| businessData | <code>BusinessData</code> | 
-
-<a name="module_BusinessData..BusinessDefault"></a>
-
-### BusinessData~BusinessDefault : <code>BusinessData</code>
-**Kind**: inner constant of [<code>BusinessData</code>](#module_BusinessData)  
-**Default**: <code>{&quot;Id&quot;:null,&quot;email&quot;:null,&quot;business_type&quot;:null,&quot;contact&quot;:null,&quot;business_address&quot;:null,&quot;mailing_address&quot;:null,&quot;billing_address&quot;:null,&quot;tel&quot;:null,&quot;mcc&quot;:null,&quot;tax_rate&quot;:null,&quot;openIssues&quot;:false}</code>  
-<a name="module_BusinessData..BusinessAccountForm"></a>
-
-### BusinessData~BusinessAccountForm : <code>BusinessData</code>
-**Kind**: inner constant of [<code>BusinessData</code>](#module_BusinessData)  
-**Default**: <code>{&quot;refPath&quot;:&quot;hidden:text&quot;,&quot;email&quot;:&quot;email&quot;,&quot;business_type&quot;:&quot;&quot;,&quot;contact&quot;:&quot;&quot;,&quot;business_address&quot;:&quot;&quot;,&quot;mailing_address&quot;:&quot;&quot;,&quot;billing_address&quot;:&quot;&quot;,&quot;tel&quot;:&quot;tel&quot;,&quot;mcc&quot;:&quot;&quot;}</code>  
-<a name="module_BusinessData..contact"></a>
-
-### BusinessData~contact : <code>object</code>
-**Kind**: inner typedef of [<code>BusinessData</code>](#module_BusinessData)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| contact.Id | <code>string</code> |  |
-| contact.first_name | <code>string</code> |  |
-| contact.last_name | <code>string</code> |  |
-| contact.tel | <code>string</code> |  |
-| contact.email | <code>string</code> | must be filled in to make profile public |
-
-<a name="module_BusinessData..BusinessData"></a>
-
-### BusinessData~BusinessData : <code>object</code>
-**Kind**: inner typedef of [<code>BusinessData</code>](#module_BusinessData)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| email | <code>string</code> | must be filled in to make profile public |
-| contact | <code>contact</code> |  |
-| tel | <code>string</code> |  |
-| business_type | <code>string</code> |  |
-| business_address | <code>AddressType</code> |  |
-| mailing_address | <code>AddressType</code> |  |
-| billing_address | <code>AddressType</code> |  |
-
-<a name="module_BusinessData..ChainType"></a>
-
-### BusinessData~ChainType : <code>WriteBatch</code> \| <code>Transaction</code> \| <code>void</code>
-**Kind**: inner typedef of [<code>BusinessData</code>](#module_BusinessData)  
 <a name="module_Commodities"></a>
 
 ## Commodities
@@ -741,166 +389,6 @@ An object to allow for paginating a table read from Firestore. REQUIRES a sortin
 | PageForward | <code>method</code> | pages the fetch forward |
 | PageBack | <code>method</code> | pages the fetch backward |
 
-<a name="module_Fundamentals"></a>
-
-## Fundamentals
-Typedefs, constants, support functions and database operations related to Fundamental
-setting from the Database *
-
-
-* [Fundamentals](#module_Fundamentals)
-    * _static_
-        * [.fetchFundamentals()](#module_Fundamentals.fetchFundamentals) ⇒ <code>Promise.&lt;Fundamentals&gt;</code>
-        * [.fetchRates()](#module_Fundamentals.fetchRates) ⇒ <code>Promise.&lt;Rates&gt;</code>
-        * [.fetchPayoutRates()](#module_Fundamentals.fetchPayoutRates) ⇒ <code>Promise.&lt;PaymentProcessor&gt;</code>
-        * [.fetchMCCs()](#module_Fundamentals.fetchMCCs) ⇒ <code>Promise.&lt;Array.MCCType&gt;</code>
-        * [.fetchBusinessTypes()](#module_Fundamentals.fetchBusinessTypes) ⇒ <code>Promise.&lt;Array.BusinessType&gt;</code>
-    * _inner_
-        * [~Rates](#module_Fundamentals..Rates) : <code>Rates</code>
-        * [~paymentProcessor](#module_Fundamentals..paymentProcessor) : <code>PaymentProcessor</code>
-        * [~MCCDefault](#module_Fundamentals..MCCDefault) : <code>MCCType</code>
-        * [~BusinessTypeDefault](#module_Fundamentals..BusinessTypeDefault) : <code>BusinessType</code>
-        * [~OrganizationFundamentals](#module_Fundamentals..OrganizationFundamentals) : <code>object</code>
-        * [~Rates](#module_Fundamentals..Rates) : <code>object</code>
-        * [~PaymentProcessor](#module_Fundamentals..PaymentProcessor) : <code>object</code>
-        * [~MCCType](#module_Fundamentals..MCCType) : <code>object</code>
-        * [~BusinessType](#module_Fundamentals..BusinessType) : <code>object</code>
-        * [~Fundamentals](#module_Fundamentals..Fundamentals) : <code>object</code>
-
-<a name="module_Fundamentals.fetchFundamentals"></a>
-
-### Fundamentals.fetchFundamentals() ⇒ <code>Promise.&lt;Fundamentals&gt;</code>
-returns a Promise which resolves with an
-array of all Fundamentals Objects (or err)
-
-**Kind**: static method of [<code>Fundamentals</code>](#module_Fundamentals)  
-<a name="module_Fundamentals.fetchRates"></a>
-
-### Fundamentals.fetchRates() ⇒ <code>Promise.&lt;Rates&gt;</code>
-returns a Promise that resolves  with the Rates record from the database
-
-**Kind**: static method of [<code>Fundamentals</code>](#module_Fundamentals)  
-<a name="module_Fundamentals.fetchPayoutRates"></a>
-
-### Fundamentals.fetchPayoutRates() ⇒ <code>Promise.&lt;PaymentProcessor&gt;</code>
-returns a Promise that resolves  with the Rates record from the database
-
-**Kind**: static method of [<code>Fundamentals</code>](#module_Fundamentals)  
-<a name="module_Fundamentals.fetchMCCs"></a>
-
-### Fundamentals.fetchMCCs() ⇒ <code>Promise.&lt;Array.MCCType&gt;</code>
-returns an array of all MCC (Merchant Commerce Code) available
-
-**Kind**: static method of [<code>Fundamentals</code>](#module_Fundamentals)  
-<a name="module_Fundamentals.fetchBusinessTypes"></a>
-
-### Fundamentals.fetchBusinessTypes() ⇒ <code>Promise.&lt;Array.BusinessType&gt;</code>
-returns an array of all MCC (Merchant Commerce Code) available
-
-**Kind**: static method of [<code>Fundamentals</code>](#module_Fundamentals)  
-<a name="module_Fundamentals..Rates"></a>
-
-### Fundamentals~Rates : <code>Rates</code>
-**Kind**: inner constant of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Default**: <code>{&quot;Id&quot;:null,&quot;service_charge&quot;:&quot;&quot;}</code>  
-<a name="module_Fundamentals..paymentProcessor"></a>
-
-### Fundamentals~paymentProcessor : <code>PaymentProcessor</code>
-**Kind**: inner constant of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Default**: <code>{&quot;connected_active&quot;:200,&quot;processing_concurrency&quot;:10,&quot;processing_rate&quot;:25,&quot;processing_time_window&quot;:1000,&quot;per_payout&quot;:25,&quot;rate_payout&quot;:25,&quot;rate_payout_scale&quot;:10000}</code>  
-<a name="module_Fundamentals..MCCDefault"></a>
-
-### Fundamentals~MCCDefault : <code>MCCType</code>
-**Kind**: inner constant of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Default**: <code>{&quot;Id&quot;:null,&quot;MCC&quot;:null,&quot;name&quot;:null,&quot;description&quot;:null,&quot;long&quot;:null,&quot;type&quot;:null}</code>  
-<a name="module_Fundamentals..BusinessTypeDefault"></a>
-
-### Fundamentals~BusinessTypeDefault : <code>BusinessType</code>
-**Kind**: inner constant of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Default**: <code>{&quot;Id&quot;:null,&quot;business_type&quot;:null,&quot;name&quot;:null,&quot;description&quot;:null}</code>  
-<a name="module_Fundamentals..OrganizationFundamentals"></a>
-
-### Fundamentals~OrganizationFundamentals : <code>object</code>
-**Kind**: inner typedef of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| Types | <code>Array.string</code> | Allowed organization types |
-
-<a name="module_Fundamentals..Rates"></a>
-
-### Fundamentals~Rates : <code>object</code>
-**Kind**: inner typedef of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| Id | <code>string</code> |  |
-| service_charge | <code>object</code> |  |
-| service_charge.minimum | <code>number</code> |  |
-| service_charge.rate | <code>number</code> | percentage |
-| service_charge.rounding_factor | <code>number</code> |  |
-
-<a name="module_Fundamentals..PaymentProcessor"></a>
-
-### Fundamentals~PaymentProcessor : <code>object</code>
-**Kind**: inner typedef of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| connected_active | <code>number</code> | allowed active connections |
-| processing_concurrency | <code>number</code> |  |
-| processing_rate | <code>number</code> |  |
-| processing_time_window | <code>number</code> |  |
-| per_payout | <code>number</code> |  |
-| rate_payout | <code>number</code> |  |
-| rate_payout_scale | <code>number</code> |  |
-
-<a name="module_Fundamentals..MCCType"></a>
-
-### Fundamentals~MCCType : <code>object</code>
-**Kind**: inner typedef of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| Id | <code>string</code> |  |
-| MCC | <code>string</code> | Merchant Class Code |
-| name | <code>string</code> | Merchant Class Code |
-| description | <code>string</code> | description of Merchant Class Code |
-| long | <code>string</code> | long description of Merchant Class Code |
-| type | <code>string</code> | Applicable business model - "Artists", "Venues" or "Brands" |
-
-<a name="module_Fundamentals..BusinessType"></a>
-
-### Fundamentals~BusinessType : <code>object</code>
-**Kind**: inner typedef of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| Id | <code>string</code> |  |
-| business_type | <code>string</code> | allowed business type value |
-| name | <code>string</code> | business type value |
-| description | <code>string</code> | description ofbusiness type value |
-
-<a name="module_Fundamentals..Fundamentals"></a>
-
-### Fundamentals~Fundamentals : <code>object</code>
-**Kind**: inner typedef of [<code>Fundamentals</code>](#module_Fundamentals)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| Rates | <code>Rates</code> |  |
-| PaymentProcessor | <code>PaymentProcessor</code> |  |
-| Defaults | <code>object</code> |  |
-| Defaults.MCC | <code>MCCType</code> |  |
-| Organizations | <code>OrganizationFundamentals</code> |  |
-| Organizations.Types | <code>Array.string</code> | Allowed organization types |
-
 <a name="module_LineItem"></a>
 
 ## LineItem
@@ -1648,127 +1136,6 @@ Changes the paidQ label on a receipt associated with a pledgeTicket
 
 ### Payment~AccountObject : <code>UserObject</code>
 **Kind**: inner typedef of [<code>Payment</code>](#module_Payment)  
-<a name="module_PrivateData"></a>
-
-## PrivateData
-Functions for managing (potentially)private data for a user or organization.
-Unified structure as a sub-record of fan, organization, or CityManager accounts
-
-
-* [PrivateData](#module_PrivateData)
-    * _static_
-        * [.fetchPrivateData(account)](#module_PrivateData.fetchPrivateData) ⇒ <code>Promise.PrivateData</code>
-        * [.createPrivateData(account, batch)](#module_PrivateData.createPrivateData) ⇒ <code>Promise.&lt;ChainType&gt;</code>
-        * [.savePrivateData(privateData)](#module_PrivateData.savePrivateData) ⇒ <code>Promise.&lt;PrivateData&gt;</code>
-        * [.deletePrivateData(privateData)](#module_PrivateData.deletePrivateData) ⇒ <code>Promise.&lt;void&gt;</code>
-        * [.privateDataPath(account)](#module_PrivateData.privateDataPath) ⇒ <code>string</code>
-    * _inner_
-        * [~PrivateDefault](#module_PrivateData..PrivateDefault) : <code>PrivateData</code>
-        * [~PrivateAccountForm](#module_PrivateData..PrivateAccountForm) : <code>PrivateData</code>
-        * [~contact](#module_PrivateData..contact) : <code>object</code>
-        * [~PrivateData](#module_PrivateData..PrivateData) : <code>object</code>
-        * [~ChainType](#module_PrivateData..ChainType) : <code>WriteBatch</code> \| <code>Transaction</code> \| <code>void</code>
-
-<a name="module_PrivateData.fetchPrivateData"></a>
-
-### PrivateData.fetchPrivateData(account) ⇒ <code>Promise.PrivateData</code>
-Fecthes the PrivateData (email, tel, addresses, etc) for a Fan account
-
-**Kind**: static method of [<code>PrivateData</code>](#module_PrivateData)  
-
-| Param | Type |
-| --- | --- |
-| account | <code>AccountType</code> | 
-
-<a name="module_PrivateData.createPrivateData"></a>
-
-### PrivateData.createPrivateData(account, batch) ⇒ <code>Promise.&lt;ChainType&gt;</code>
-**Kind**: static method of [<code>PrivateData</code>](#module_PrivateData)  
-**Returns**: <code>Promise.&lt;ChainType&gt;</code> - WriteBatch, Transaction or Void  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| account | <code>AccountType</code> |  |
-| batch | <code>ChainType</code> | batching object.  Transaction will be added to the batch |
-
-<a name="module_PrivateData.savePrivateData"></a>
-
-### PrivateData.savePrivateData(privateData) ⇒ <code>Promise.&lt;PrivateData&gt;</code>
-Writes the "private" data to the database
-
-**Kind**: static method of [<code>PrivateData</code>](#module_PrivateData)  
-
-| Param | Type |
-| --- | --- |
-| privateData | <code>PrivateData</code> | 
-
-<a name="module_PrivateData.deletePrivateData"></a>
-
-### PrivateData.deletePrivateData(privateData) ⇒ <code>Promise.&lt;void&gt;</code>
-Deletes a PrivateData record (rarely used if ever)
-
-**Kind**: static method of [<code>PrivateData</code>](#module_PrivateData)  
-
-| Param | Type |
-| --- | --- |
-| privateData | <code>PrivateData</code> | 
-| privateData.refPath | <code>string</code> | 
-
-<a name="module_PrivateData.privateDataPath"></a>
-
-### PrivateData.privateDataPath(account) ⇒ <code>string</code>
-creates the "base path" (refPath) to store addresses based on an account (refPath)
-
-**Kind**: static method of [<code>PrivateData</code>](#module_PrivateData)  
-
-| Param | Type |
-| --- | --- |
-| account | <code>Record</code> | 
-| account.refPath | <code>string</code> | 
-
-<a name="module_PrivateData..PrivateDefault"></a>
-
-### PrivateData~PrivateDefault : <code>PrivateData</code>
-**Kind**: inner constant of [<code>PrivateData</code>](#module_PrivateData)  
-**Default**: <code>{&quot;Id&quot;:null,&quot;email&quot;:null,&quot;contact&quot;:null,&quot;business_address&quot;:null,&quot;mailing_address&quot;:null,&quot;billing_address&quot;:null,&quot;tel&quot;:null,&quot;tax_rate&quot;:null,&quot;openIssues&quot;:false}</code>  
-<a name="module_PrivateData..PrivateAccountForm"></a>
-
-### PrivateData~PrivateAccountForm : <code>PrivateData</code>
-**Kind**: inner constant of [<code>PrivateData</code>](#module_PrivateData)  
-**Default**: <code>{&quot;refPath&quot;:&quot;hidden:text&quot;,&quot;email&quot;:&quot;email&quot;,&quot;contact&quot;:&quot;&quot;,&quot;business_address&quot;:&quot;&quot;,&quot;mailing_address&quot;:&quot;&quot;,&quot;billing_address&quot;:&quot;&quot;,&quot;tel&quot;:&quot;tel&quot;}</code>  
-<a name="module_PrivateData..contact"></a>
-
-### PrivateData~contact : <code>object</code>
-**Kind**: inner typedef of [<code>PrivateData</code>](#module_PrivateData)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| contact.Id | <code>string</code> |  |
-| contact.first_name | <code>string</code> |  |
-| contact.last_name | <code>string</code> |  |
-| contact.tel | <code>string</code> |  |
-| contact.email | <code>string</code> | must be filled in to make profile public |
-
-<a name="module_PrivateData..PrivateData"></a>
-
-### PrivateData~PrivateData : <code>object</code>
-**Kind**: inner typedef of [<code>PrivateData</code>](#module_PrivateData)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| email | <code>string</code> | must be filled in to make profile public |
-| contact | <code>contact</code> |  |
-| tel | <code>string</code> |  |
-| business_address | <code>AddressType</code> |  |
-| mailing_address | <code>AddressType</code> |  |
-| billing_address | <code>AddressType</code> |  |
-
-<a name="module_PrivateData..ChainType"></a>
-
-### PrivateData~ChainType : <code>WriteBatch</code> \| <code>Transaction</code> \| <code>void</code>
-**Kind**: inner typedef of [<code>PrivateData</code>](#module_PrivateData)  
 <a name="module_Product"></a>
 
 ## Product
@@ -1785,20 +1152,6 @@ Typedefs, constants, support functions and database operations related to Produc
         * [~ProductDefaultForm](#module_Product..ProductDefaultForm) : <code>Product</code>
         * [~updateProduct(product, user)](#module_Product..updateProduct) ⇒ <code>promise.LineItem</code>
         * [~summarizeProduct(product)](#module_Product..summarizeProduct) ⇒ <code>string</code>
-        * [~Recipe_Data](#module_Product..Recipe_Data) : <code>object</code>
-        * [~AttributeList](#module_Product..AttributeList) : <code>Array.String</code>
-        * [~AttributeValue](#module_Product..AttributeValue) : <code>object</code>
-        * [~ProductImage](#module_Product..ProductImage) : <code>object</code>
-        * [~CurrencyDescription](#module_Product..CurrencyDescription) : <code>object</code>
-        * [~MonetaryValue](#module_Product..MonetaryValue) : <code>object</code>
-        * [~FullProductPricing](#module_Product..FullProductPricing) : <code>object</code>
-        * [~ProductDimensions](#module_Product..ProductDimensions) : <code>object</code>
-        * [~PriceObject](#module_Product..PriceObject) : <code>object</code>
-        * [~ProductWeight](#module_Product..ProductWeight) : <code>object</code>
-        * [~ProductMeasurements](#module_Product..ProductMeasurements) : <code>object</code>
-        * [~ProductStock](#module_Product..ProductStock) : <code>object</code>
-        * [~PhysicalProductVariant](#module_Product..PhysicalProductVariant) : <code>object</code>
-        * [~MetaData](#module_Product..MetaData) : <code>object</code>
         * [~Product](#module_Product..Product) : <code>object</code>
 
 <a name="module_Product.createProduct"></a>
@@ -1825,7 +1178,7 @@ Creates a new Blank Product
 
 ### Product~ProductDefault : <code>Product</code>
 **Kind**: inner constant of [<code>Product</code>](#module_Product)  
-**Default**: <code>{&quot;name&quot;:&quot;&quot;,&quot;description&quot;:null,&quot;recipe&quot;:&quot;&quot;,&quot;image_links&quot;:&quot;&quot;,&quot;type&quot;:&quot;&quot;,&quot;google_product_type&quot;:&quot;&quot;,&quot;shipping_time&quot;:0,&quot;condition&quot;:&quot;&quot;,&quot;adultQ&quot;:false,&quot;age_group&quot;:&quot;adult&quot;,&quot;color&quot;:&quot;&quot;,&quot;material&quot;:&quot;&quot;,&quot;gender&quot;:&quot;unisex&quot;,&quot;attributes_gemstones&quot;:&quot;&quot;,&quot;pattern&quot;:&quot;&quot;,&quot;size&quot;:&quot;&quot;,&quot;weight&quot;:0,&quot;shippingMeasurements&quot;:&quot;&quot;}</code>  
+**Default**: <code>{&quot;Id&quot;:null,&quot;refPath&quot;:null,&quot;name&quot;:&quot;&quot;,&quot;description&quot;:null,&quot;sku&quot;:null,&quot;markups&quot;:null,&quot;projectQ&quot;:false,&quot;created&quot;:null,&quot;modified&quot;:null}</code>  
 **Read only**: true  
 <a name="module_Product..ProductDataForm"></a>
 
@@ -1864,221 +1217,25 @@ Returns a standardized formatted name string
 | --- | --- |
 | product | <code>Unit</code> | 
 
-<a name="module_Product..Recipe_Data"></a>
-
-### Product~Recipe\_Data : <code>object</code>
-"recipe" related values - build-stage markups, product/project Flag, created/modified dates
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| markups | <code>module:Markups~Stage</code> |  |
-| projectQ | <code>boolean</code> | flag for product/project |
-| created | <code>dateTime</code> |  |
-| modified | <code>dateTime</code> |  |
-
-<a name="module_Product..AttributeList"></a>
-
-### Product~AttributeList : <code>Array.String</code>
-A list of attributes for a product
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-<a name="module_Product..AttributeValue"></a>
-
-### Product~AttributeValue : <code>object</code>
-Array of attribute name/value pairs
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| attibuteName | <code>string</code> | attribute name from attribute list |
-| value | <code>string</code> | value for the particular attribute |
-
-<a name="module_Product..ProductImage"></a>
-
-### Product~ProductImage : <code>object</code>
-Image Descriptor
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| altText | <code>string</code> | alt text for the image - SEO etc |
-| availableFormats | <code>Array.string</code> | Available image sizes. |
-| id | <code>string</code> | unique id for this productImage |
-| orderIndex | <code>integer</code> | Position of the image in the product's image list. |
-| originalSize | <code>object</code> | Image size when first uploaded. |
-| seoOptions | <code>MetaData</code> |  |
-| URL | <code>string</code> | Absolute URL of the hosted image. |
-
-<a name="module_Product..CurrencyDescription"></a>
-
-### Product~CurrencyDescription : <code>object</code>
-Currency Description ISO 4217 currency code
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type |
-| --- | --- |
-| currencyCode | <code>string</code> | 
-| defaultFractionDigits | <code>integer</code> | 
-| displayName | <code>string</code> | 
-| numericCodeAsString | <code>string</code> | 
-| symbol | <code>string</code> | 
-
-<a name="module_Product..MonetaryValue"></a>
-
-### Product~MonetaryValue : <code>object</code>
-Monetary Value Specification
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-|  | <code>CurrencyDescription</code> |  |
-| value | <code>decimal</code> | Decimal monetary value |
-
-<a name="module_Product..FullProductPricing"></a>
-
-### Product~FullProductPricing : <code>object</code>
-Pricing Object
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type |
-| --- | --- |
-| basePrice | <code>MonetaryValue</code> | 
-| onSale | <code>boolean</code> | 
-| salePrice | <code>MonetaryValue</code> | 
-
-<a name="module_Product..ProductDimensions"></a>
-
-### Product~ProductDimensions : <code>object</code>
-Dimensions Object
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| height | <code>float</code> |  |
-| width | <code>float</code> |  |
-| length | <code>float</code> |  |
-| unit | <code>text</code> | //​ProductDimensionsUnit |
-
-<a name="module_Product..PriceObject"></a>
-
-### Product~PriceObject : <code>object</code>
-Price Object
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-<a name="module_Product..ProductWeight"></a>
-
-### Product~ProductWeight : <code>object</code>
-Weight Object
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| unit | <code>text</code> | //​ProductWeightUnitEnum |
-| value | <code>float</code> |  |
-
-<a name="module_Product..ProductMeasurements"></a>
-
-### Product~ProductMeasurements : <code>object</code>
-Measurements of the variant when it's shipped. Present for PHYSICAL products only.
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type |
-| --- | --- |
-| dimensions | <code>ProductDimensions</code> | 
-| weight | <code>ProductWeight</code> | 
-
-<a name="module_Product..ProductStock"></a>
-
-### Product~ProductStock : <code>object</code>
-Available stock for the variant. Present for PHYSICAL products only.
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type |
-| --- | --- |
-| quantity | <code>integer</code> | 
-| unlimited | <code>boolean</code> | 
-
-<a name="module_Product..PhysicalProductVariant"></a>
-
-### Product~PhysicalProductVariant : <code>object</code>
-variant record (including inventory and pricing)
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| attributes | <code>Array.AttributeValue</code> | array of attribute/value pairs for a variant |
-| sku | <code>string</code> |  |
-| mpn | <code>string</code> | manufacturer part number |
-| gtin | <code>string</code> | Global Trade Item Number |
-| id | <code>string</code> | unique ID for product variant |
-| image | <code>ProductImage</code> | Image associated with this variant |
-| shippingMeasurements | <code>ProductMeasurements</code> |  |
-| stock | <code>ProductStock</code> |  |
-
-<a name="module_Product..MetaData"></a>
-
-### Product~MetaData : <code>object</code>
-Meta Information for SEO
-
-**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
-**Properties**
-
-| Name | Type |
-| --- | --- |
-| title | <code>string</code> | 
-| description | <code>string</code> | 
-
 <a name="module_Product..Product"></a>
 
 ### Product~Product : <code>object</code>
-a product record
+a record
 
 **Kind**: inner typedef of [<code>Product</code>](#module_Product)  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| Id | <code>string</code> | Database Id of document (redundant for convenience) |
+| Id | <code>string</code> | Id of document (redundant for convenience) |
 | refPath | <code>string</code> | if from database, full path to document |
 | name | <code>string</code> | name for the Product |
-| description | <code>string</code> | Basic description of the product |
-| recipe | <code>Recipe\_Data</code> | pricing and fabrication data |
-| image_links | <code>Array:ImageLinks</code> |  |
-| type | <code>text</code> | //​ProductTypeV2Enum |
-| isVisible | <code>boolean</code> |  |
-| seoOptions | <code>MetaData</code> |  |
-| name | <code>string</code> | name for the Product |
-| seoOptions | <code>MetaData</code> |  |
-| tags | <code>Array.string</code> |  |
-| materials | <code>Array.string</code> |  |
-| patterns | <code>Array.string</code> |  |
-| URL | <code>string</code> |  |
-| urlSlug | <code>string</code> |  |
-| variantAttributes | <code>Array.string</code> |  |
-| variants | <code>Array.PhysicalProductVariant</code> |  |
+| description | <code>string</code> |  |
+| sku | <code>string</code> |  |
+| markups | <code>module:Markups~Stage</code> |  |
+| projectQ | <code>boolean</code> | flag for product/project |
+| created | <code>dateTime</code> |  |
+| modified | <code>dateTime</code> |  |
 
 <a name="module_User"></a>