diff --git a/docs/dist/documentation.md b/docs/dist/documentation.md index 57880e1e3..901c37420 100644 --- a/docs/dist/documentation.md +++ b/docs/dist/documentation.md @@ -7654,7 +7654,8 @@ key=customer key | --- | --- | --- | | [ID] | string | equal to UserID; optional in update/create calls | | UserID | string | equal to ID; required in update/create calls | -| AccountUserID | number | user.AccountUserID | +| [AccountUserID] | number | user.AccountUserID | +| c__AccountUserID | number | copy of AccountUserID | | CustomerKey | string | user.CustomerKey | | Name | string | user.Name | | Email | string | user.Email | @@ -7662,15 +7663,30 @@ key=customer key | ActiveFlag | boolean | user.ActiveFlag === true ? '✓' : '-' | | IsAPIUser | boolean | user.IsAPIUser === true ? '✓' : '-' | | MustChangePassword | boolean | user.MustChangePassword === true ? '✓' : '-' | -| DefaultBusinessUnit | boolean | defaultBUName | +| DefaultBusinessUnit | number | defaultBUName | | AssociatedBusinessUnits__c | Array.<number> | associatedBus | -| [Roles] | object | roles (API only) | -| RoleNamesGlobal__c | Array.<string> | roles | +| [Roles] | object | (API only) | +| [Roles.Role] | Array.<object> | roles (API only) | +| c__RoleNamesGlobal | Array.<string> | roles | | type__c | 'User' \| 'Installed Package' | roles | | UserPermissions | Array.<string> | userPermissions | | LastSuccessfulLogin | string | this.timeSinceDate(user.LastSuccessfulLogin) | | CreatedDate | string | user.CreatedDate | | ModifiedDate | string | user.ModifiedDate | +| Client | object | - | +| [Client.ID] | number | EID e.g:7281698 | +| Client.ModifiedBy | number | AccountUserID of user who last modified this user | +| c__type | 'User' \| 'Installed Package' | - | +| [IsLocked] | boolean | (API only) | +| [Unlock] | boolean | used to unlock a user that has IsLocked === true | +| c__IsLocked_readOnly | boolean | copy of IsLocked | +| c__TimeZoneName | string | name of timezone | +| [TimeZone] | object | (API only) | +| [TimeZone.Name] | string | (API only) | +| [TimeZone.ID] | string | (API only) | +| c__LocaleCode | 'en-US' \| 'fr-CA' \| 'fr-FR' \| 'de-DE' \| 'it-IT' \| 'ja-JP' \| 'pt-BR' \| 'es-419' \| 'es-ES' | fr-CA, en-US, ... | +| [Locale] | object | (API only) | +| [Locale.LocaleCode] | 'en-US' \| 'fr-CA' \| 'fr-FR' \| 'de-DE' \| 'it-IT' \| 'ja-JP' \| 'pt-BR' \| 'es-419' \| 'es-ES' | (API only) | diff --git a/types/mcdev.d.js b/types/mcdev.d.js index fa72610e1..6dee4861b 100644 --- a/types/mcdev.d.js +++ b/types/mcdev.d.js @@ -122,7 +122,8 @@ const SDK = require('sfmc-sdk'); * @typedef {object} UserDocument * @property {string} [ID] equal to UserID; optional in update/create calls * @property {string} UserID equal to ID; required in update/create calls - * @property {number} AccountUserID user.AccountUserID + * @property {number} [AccountUserID] user.AccountUserID + * @property {number} c__AccountUserID copy of AccountUserID * @property {string} CustomerKey user.CustomerKey * @property {string} Name user.Name * @property {string} Email user.Email @@ -130,15 +131,30 @@ const SDK = require('sfmc-sdk'); * @property {boolean} ActiveFlag user.ActiveFlag === true ? '✓' : '-' * @property {boolean} IsAPIUser user.IsAPIUser === true ? '✓' : '-' * @property {boolean} MustChangePassword user.MustChangePassword === true ? '✓' : '-' - * @property {boolean} DefaultBusinessUnit defaultBUName + * @property {number} DefaultBusinessUnit defaultBUName * @property {number[]} AssociatedBusinessUnits__c associatedBus - * @property {object} [Roles] roles (API only) - * @property {string[]} RoleNamesGlobal__c roles + * @property {object} [Roles] (API only) + * @property {object[]} [Roles.Role] roles (API only) + * @property {string[]} c__RoleNamesGlobal roles * @property {'User'|'Installed Package'} type__c roles * @property {string[]} UserPermissions userPermissions * @property {string} LastSuccessfulLogin this.timeSinceDate(user.LastSuccessfulLogin) * @property {string} CreatedDate user.CreatedDate * @property {string} ModifiedDate user.ModifiedDate + * @property {object} Client - + * @property {number} [Client.ID] EID e.g:7281698 + * @property {number} Client.ModifiedBy AccountUserID of user who last modified this user + * @property {'User'|'Installed Package'} c__type - + * @property {boolean} [IsLocked] (API only) + * @property {boolean} [Unlock] used to unlock a user that has IsLocked === true + * @property {boolean} c__IsLocked_readOnly copy of IsLocked + * @property {string} c__TimeZoneName name of timezone + * @property {object} [TimeZone] (API only) + * @property {string} [TimeZone.Name] (API only) + * @property {string} [TimeZone.ID] (API only) + * @property {'en-US'|'fr-CA'|'fr-FR'|'de-DE'|'it-IT'|'ja-JP'|'pt-BR'|'es-419'|'es-ES'} c__LocaleCode fr-CA, en-US, ... + * @property {object} [Locale] (API only) + * @property {'en-US'|'fr-CA'|'fr-FR'|'de-DE'|'it-IT'|'ja-JP'|'pt-BR'|'es-419'|'es-ES'} [Locale.LocaleCode] (API only) * @typedef {{before:UserDocument,after:UserDocument}} UserDocumentDiff * @typedef {Object.} UserDocumentMap key=customer key */