new SoapApi(conn)
API class for Partner SOAP call
Parameters:
| Name | Type | Description |
|---|---|---|
conn |
Connection | Connection |
- Source:
Methods
convertLead(leadConverts, callbackopt) → {Promise.<(SoapApi~LeadConvertResult|Array.<SoapApi~LeadConvertResult>)>}
Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
leadConverts |
SoapApi~LeadConvert | Array.<SoapApi~LeadConvert> | ||
callback |
Callback.<(SoapApi~LeadConvertResult|Array.<SoapApi~LeadConvertResult>)> |
<optional> |
Callback function |
- Source:
Returns:
- Type
- Promise.<(SoapApi~LeadConvertResult|Array.<SoapApi~LeadConvertResult>)>
describeTabs(callbackopt) → {Promise.<Array.<SoapApi~DescribeTabSetResult>>}
Returns information about the standard and custom apps available to the logged-in user
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
callback |
Callback.<Array.<SoapApi~DescribeTabSetResult>> |
<optional> |
Callback function |
- Source:
Returns:
- Type
- Promise.<Array.<SoapApi~DescribeTabSetResult>>
emptyRecycleBin(ids, callbackopt) → {Promise.<Array.<SoapApi~EmptyRecycleBinResult>>}
Delete records from the recycle bin immediately
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ids |
Array.<String> | Record ids to empty from recycle bin | |
callback |
Callback.<Array.<SoapApi~EmptyRecycleBinResult>> |
<optional> |
Callback function |
- Source:
Returns:
- Type
- Promise.<Array.<SoapApi~EmptyRecycleBinResult>>
getServerTimestamp(callbackopt) → {Promise.<SoapApi~ServerTimestampResult>}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
callback |
Callback.<SoapApi~ServerTimestampResult> |
<optional> |
Callback function |
- Source:
Returns:
getUserInfo(callbackopt) → {Promise.<SoapApi~UserInfoResult>}
Retrieves personal information for the user associated with the current session
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
callback |
Callback.<SoapApi~UserInfoResult> |
<optional> |
Callback function |
- Source:
Returns:
- Type
- Promise.<SoapApi~UserInfoResult>
merge(mergeRequests, callbackopt) → {Promise.<(SoapApi~MergeResult|Array.<SoapApi~MergeResult>)>}
Merge up to three records into one
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
mergeRequests |
SoapApi~MergeRequest | Array.<SoapApi~MergeRequest> | ||
callback |
Callback.<(SoapApi~MergeResult|Array.<SoapApi~MergeResult>)> |
<optional> |
Callback function |
- Source:
Returns:
- Type
- Promise.<(SoapApi~MergeResult|Array.<SoapApi~MergeResult>)>
resetPassword(userId, password, callbackopt) → {Promise.<SoapApi~ResetPasswordResult>}
Resets the specified user’s password
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
userId |
String | User Id to set password | |
password |
String | New password | |
callback |
Callback.<SoapApi~ResetPasswordResult> |
<optional> |
Callback function |
- Source:
Returns:
setPassword(userId, password, callbackopt) → {Promise.<String>}
Sets the specified user’s password to the specified value
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
userId |
String | User Id to set password | |
password |
String | New password | |
callback |
Callback.<String> |
<optional> |
Callback function |
- Source:
Returns:
- Type
- Promise.<String>
Type Definitions
DescribeTab
Properties:
| Name | Type | Description |
|---|---|---|
colors |
Array.<Object> | Array of color information used for a tab |
custom |
Boolean | true if this is a custom tab |
iconUrl |
String | The URL for the main 32 x 32 pixel icon for a tab |
icons |
Array.<Object> | Array of icon information used for a tab |
label |
String | The display label for this tab |
miniIconUrl |
String | The URL for the 16 x 16 pixel icon that represents a tab |
name |
String | The API name of the tab |
sobjectName |
String | The name of the sObject that is primarily displayed on this tab |
url |
String | A fully qualified URL for viewing this tab |
- Source:
DescribeTabSetResult
Properties:
| Name | Type | Description |
|---|---|---|
label |
String | The display label for this standard or custom app |
logoUrl |
String | A fully qualified URL to the logo image associated with the standard or custom app |
namespace |
String | Namespace of application package |
selected |
Boolean | If true, then this standard or custom app is the user’s currently selected app |
tabs |
Array.<SoapApi~DescribeTab> | An array of tabs that are displayed for the specified standard app or custom app |
- Source:
EmptyRecycleBinResult
Properties:
| Name | Type | Description |
|---|---|---|
id |
String | ID of an sObject that you attempted to delete from the Recycle Bin |
success |
Boolean | Whether the call succeeded (true) or not (false) for this record |
errors |
Array.<Object> | Errors |
- Source:
LeadConvert
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
convertedStatus |
String | Status of converted lead | |
leadId |
String | Lead record Id to convert | |
accountId |
String |
<optional> |
Account record Id to assign the converted record |
contactId |
String |
<optional> |
Contact record Id to assign the converted record |
doNotCreateOpportunity |
Boolean |
<optional> |
True if you don't want to create a new opportunity |
opportunityName |
String |
<optional> |
Name of opportunity to create |
overwriteLeadSource |
Boolean |
<optional> |
True if overwriting lead source |
ownerId |
String |
<optional> |
Owner Id |
sendNotificationEmail |
Boolean |
<optional> |
True if send notification email |
- Source:
LeadConvertResult
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
leadId |
String | Lead record Id to convert | |
accountId |
String |
<optional> |
Account record Id of converted lead |
contactId |
String |
<optional> |
Contact record Id of converted lead |
opportunityId |
String |
<optional> |
Opportunity record Id created in conversion |
success |
Boolean | True if successfully converted | |
errors |
Array.<Object> | Error |
- Source:
MergeRequest
Properties:
| Name | Type | Description |
|---|---|---|
masterRecord |
Object | The merge destination record |
recordToMergeIds |
Array.<String> | Ids of records to merge |
- Source:
MergeResult
Properties:
| Name | Type | Description |
|---|---|---|
success |
Boolean | True if successfully merged |
errors |
Array.<Object> | Error |
id |
String | ID of the master record |
mergedRecordIds |
Array.<String> | ID of the records that were merged into the master record |
updatedRelatedIds |
Array.<String> | ID of all related records that were moved (re-parented) as a result of the merge |
- Source:
ResetPasswordResult
Properties:
| Name | Type | Description |
|---|---|---|
password |
String |
- Source:
ServerTimestampResult
Retrieves the current system timestamp (Coordinated Universal Time (UTC) time zone) from the API
Properties:
| Name | Type | Description |
|---|---|---|
timestamp |
String | Timestamp |
- Source:
UserInfoResult
Properties:
| Name | Type | Description |
|---|---|---|
accessibilityMode |
Boolean | |
currencySymbol |
String | |
orgAttachmentFileSizeLimit |
Number | |
orgDefaultCurrencyIsoCode |
String | |
orgDisallowHtmlAttachments |
String | |
orgHasPersonAccounts |
Boolean | |
organizationId |
String | |
organizationMultiCurrency |
Boolean | |
organizationName |
String | |
profileId |
String | |
roleId |
String | |
sessionSecondsValid |
Number | |
userDefaultCurrencyIsoCode |
String | |
userEmail |
String | |
userFullName |
String | |
userId |
String | |
userLanguage |
String | |
userLocale |
String | |
userName |
String | |
userTimeZone |
String | |
userType |
String | |
userUiSkin |
String |
- Source: