Skip to content

Commit

Permalink
#139: bump User type definition to match latest field updates
Browse files Browse the repository at this point in the history
  • Loading branch information
JoernBerkefeld committed Mar 23, 2023
1 parent 225f2a2 commit 03afd8b
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 8 deletions.
24 changes: 20 additions & 4 deletions docs/dist/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7654,23 +7654,39 @@ key=customer key
| --- | --- | --- |
| [ID] | <code>string</code> | equal to UserID; optional in update/create calls |
| UserID | <code>string</code> | equal to ID; required in update/create calls |
| AccountUserID | <code>number</code> | user.AccountUserID |
| [AccountUserID] | <code>number</code> | user.AccountUserID |
| c__AccountUserID | <code>number</code> | copy of AccountUserID |
| CustomerKey | <code>string</code> | user.CustomerKey |
| Name | <code>string</code> | user.Name |
| Email | <code>string</code> | user.Email |
| NotificationEmailAddress | <code>string</code> | user.NotificationEmailAddress |
| ActiveFlag | <code>boolean</code> | user.ActiveFlag === true ? '✓' : '-' |
| IsAPIUser | <code>boolean</code> | user.IsAPIUser === true ? '✓' : '-' |
| MustChangePassword | <code>boolean</code> | user.MustChangePassword === true ? '✓' : '-' |
| DefaultBusinessUnit | <code>boolean</code> | defaultBUName |
| DefaultBusinessUnit | <code>number</code> | defaultBUName |
| AssociatedBusinessUnits__c | <code>Array.&lt;number&gt;</code> | associatedBus |
| [Roles] | <code>object</code> | roles (API only) |
| RoleNamesGlobal__c | <code>Array.&lt;string&gt;</code> | roles |
| [Roles] | <code>object</code> | (API only) |
| [Roles.Role] | <code>Array.&lt;object&gt;</code> | roles (API only) |
| c__RoleNamesGlobal | <code>Array.&lt;string&gt;</code> | roles |
| type__c | <code>&#x27;User&#x27;</code> \| <code>&#x27;Installed Package&#x27;</code> | roles |
| UserPermissions | <code>Array.&lt;string&gt;</code> | userPermissions |
| LastSuccessfulLogin | <code>string</code> | this.timeSinceDate(user.LastSuccessfulLogin) |
| CreatedDate | <code>string</code> | user.CreatedDate |
| ModifiedDate | <code>string</code> | user.ModifiedDate |
| Client | <code>object</code> | - |
| [Client.ID] | <code>number</code> | EID e.g:7281698 |
| Client.ModifiedBy | <code>number</code> | AccountUserID of user who last modified this user |
| c__type | <code>&#x27;User&#x27;</code> \| <code>&#x27;Installed Package&#x27;</code> | - |
| [IsLocked] | <code>boolean</code> | (API only) |
| [Unlock] | <code>boolean</code> | used to unlock a user that has IsLocked === true |
| c__IsLocked_readOnly | <code>boolean</code> | copy of IsLocked |
| c__TimeZoneName | <code>string</code> | name of timezone |
| [TimeZone] | <code>object</code> | (API only) |
| [TimeZone.Name] | <code>string</code> | (API only) |
| [TimeZone.ID] | <code>string</code> | (API only) |
| c__LocaleCode | <code>&#x27;en-US&#x27;</code> \| <code>&#x27;fr-CA&#x27;</code> \| <code>&#x27;fr-FR&#x27;</code> \| <code>&#x27;de-DE&#x27;</code> \| <code>&#x27;it-IT&#x27;</code> \| <code>&#x27;ja-JP&#x27;</code> \| <code>&#x27;pt-BR&#x27;</code> \| <code>&#x27;es-419&#x27;</code> \| <code>&#x27;es-ES&#x27;</code> | fr-CA, en-US, ... |
| [Locale] | <code>object</code> | (API only) |
| [Locale.LocaleCode] | <code>&#x27;en-US&#x27;</code> \| <code>&#x27;fr-CA&#x27;</code> \| <code>&#x27;fr-FR&#x27;</code> \| <code>&#x27;de-DE&#x27;</code> \| <code>&#x27;it-IT&#x27;</code> \| <code>&#x27;ja-JP&#x27;</code> \| <code>&#x27;pt-BR&#x27;</code> \| <code>&#x27;es-419&#x27;</code> \| <code>&#x27;es-ES&#x27;</code> | (API only) |

<a name="BusinessUnitAssignmentConfiguration"></a>

Expand Down
24 changes: 20 additions & 4 deletions types/mcdev.d.js
Original file line number Diff line number Diff line change
Expand Up @@ -122,23 +122,39 @@ 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
* @property {string} NotificationEmailAddress user.NotificationEmailAddress
* @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.<string, UserDocument>} UserDocumentMap key=customer key
*/
Expand Down

0 comments on commit 03afd8b

Please sign in to comment.