salesforce
Modules
Module salesforce
API
ballerinax/salesforce Ballerina library
Clients
salesforce: Client
Ballerina Salesforce connector provides the capability to access Salesforce REST API. This connector lets you to perform operations for SObjects, query using SOQL, search using SOSL, and describe SObjects and organizational data.
Deprecated
This client class is deprecated as it is exposed as a seperate client.
Use the new and improved salesforce.rest
client instead.
Constructor
Initializes the connector. During initialization you can pass either http:BearerTokenConfig if you have a bearer token or http:OAuth2RefreshTokenGrantConfig if you have Oauth tokens. Create a Salesforce account and obtain tokens following this guide.
init (ConnectionConfig salesforceConfig)
- salesforceConfig ConnectionConfig - Salesforce Connector configuration
describeAvailableObjects
function describeAvailableObjects() returns OrgMetadata|Error
Lists the available objects and their metadata for your organization and available to the logged-in user.
Return Type
- OrgMetadata|Error -
OrgMetadata
record if successful or elsesfdc:Error
Deprecated
This function is deprecated as thesalesforce
client is deprecated. Use thedescribeAvailableObjects
function insalesforce.rest
client instead.
getSObjectBasicInfo
function getSObjectBasicInfo(string sobjectName) returns SObjectBasicInfo|Error
Describes the individual metadata for the specified object.
Parameters
- sobjectName string - SObject name
Return Type
- SObjectBasicInfo|Error -
SObjectBasicInfo
record if successful or elsesfdc:Error
Deprecated
This function is deprecated as thesalesforce
client is deprecated. Use thegetSObjectBasicInfo
function insalesforce.rest
client instead.
describeSObject
function describeSObject(string sObjectName) returns SObjectMetaData|Error
Completely describes the individual metadata at all levels for the specified object. Can be used to retrieve the fields, URLs, and child relationships.
Parameters
- sObjectName string - SObject name value
Return Type
- SObjectMetaData|Error -
SObjectMetaData
record if successful or elsesfdc:Error
Deprecated
This function is deprecated as thesalesforce
client is deprecated. Use thedescribeSObject
function insalesforce.rest
client instead.
sObjectPlatformAction
function sObjectPlatformAction() returns SObjectBasicInfo|Error
Query for actions displayed in the UI, given a user, a context, device format, and a record ID.
Return Type
- SObjectBasicInfo|Error -
SObjectBasicInfo
record if successful or elsesfdc:Error
Deprecated
This function is deprecated as thesalesforce
client is deprecated. Use thesObjectPlatformAction
function insalesforce.rest
client instead.
getAvailableApiVersions
Lists summary details about each REST API version available.
Return Type
getResourcesByApiVersion
Lists the resources available for the specified API version.
Parameters
- apiVersion string - API version (v37)
Return Type
getOrganizationLimits
Lists the Limits information for your organization.
Return Type
getRecord
Accesses records based on the specified object ID, can be used with external objects.
Parameters
- path string - Resource path
Return Type
- json|Error - JSON result if successful else or else
sfdc:Error
Deprecated
This function is deprecated as it returns a json response. Use the new and improvedgetById(string sObject, string id)
function instead.
getRecordById
Gets an object record by ID.
Return Type
- json|Error - JSON result if successful or else
sfdc:Error
Deprecated
This function is deprecated as it returns a json response. Use the new and improvedgetById(string sObject, string id)
function instead.
getRecordByExtId
function getRecordByExtId(string sobject, string extIdField, string extId, string... fields) returns json|Error
Gets an object record by external ID.
Parameters
- sobject string - SObject name
- extIdField string - External ID field name
- extId string - External ID value
- fields string... - Fields to retrieve
Return Type
- json|Error - JSON result if successful or else
sfdc:Error
Deprecated
This function is deprecated as it returns a json response. Use the new and improvedgetByExternalId(string sObject, string extIdField, string extId)
function instead.
createRecord
Creates records based on relevant object type sent with json record.
Return Type
deleteRecord
Delete existing records based on relevant object ID.
Return Type
- Error? - true if successful else false or else
sfdc:Error
Deprecated
This function is deprecated to rename it. Use the new and improveddelete(string sObjectName, string id)
function instead.
updateRecord
Updates records based on relevant object ID.
Parameters
- sObjectName string - SObject name value
- id string - SObject ID
- recordPayload json - JSON record to be updated
Return Type
- Error? - true if successful else false or else
sfdc:Error
Deprecated
This function is deprecated as it expects a json payload. Use the new and improvedupdate(string sObjectName, string id, record{} recordPayload)
function instead.
getAccountById
Accesses Account SObject records based on the Account object ID.
Return Type
- json|Error - JSON response if successful or else an sfdc:Error
Deprecated
This function is deprecated as it returns a json response. Use the new and improvedgetById(string sObject, string id)
function instead.
createAccount
Creates new Account object record.
Parameters
- accountRecord json - Account JSON record to be inserted
Return Type
deleteAccount
Deletes existing Account's records.
Parameters
- accountId string - Account ID
Return Type
- Error? -
true
if successfulfalse
otherwise, or an sfdc:Error in case of an errorDeprecated
This function is deprecated to rename it. Use the new and improveddelete(string sObjectName, string id)
function instead.
updateAccount
Updates existing Account object record.
Return Type
- Error? -
true
if successful,false
otherwise or an sfdc:Error in case of an errorDeprecated
This function is deprecated as it expects a json payload. Use the new and improvedupdate(string sObjectName, string id, record{} recordPayload)
function instead.
getLeadById
Accesses Lead SObject records based on the Lead object ID.
Return Type
- json|Error - JSON response if successful or else an sfdc:Error
Deprecated
This function is deprecated as it returns a json response. Use the new and improvedgetById(string sObject, string id)
function instead.
createLead
Creates new Lead object record.
Parameters
- leadRecord json - Lead JSON record to be inserted
Return Type
deleteLead
Deletes existing Lead's records.
Parameters
- leadId string - Lead ID
Return Type
- Error? -
true
if successful,false
otherwise or an sfdc:Error incase of an errorDeprecated
This function is deprecated to rename it. Use the new and improveddelete(string sObjectName, string id)
function instead.
updateLead
Updates existing Lead object record.
Return Type
- Error? -
true
if successful,false
otherwise or an sfdc:Error in case of an errorDeprecated
This function is deprecated as it expects a json payload. Use the new and improvedupdate(string sObjectName, string id, record{} recordPayload)
function instead.
getContactById
Accesses Contacts SObject records based on the Contact object ID.
Return Type
- json|Error - JSON result if successful or else an sfdc:Error
Deprecated
This function is deprecated as it returns a json response. Use the new and improvedgetById(string sObject, string id)
function instead.
createContact
Creates new Contact object record.
Parameters
- contactRecord json - JSON contact record
Return Type
deleteContact
Deletes existing Contact's records.
Parameters
- contactId string - Contact ID
Return Type
- Error? -
true
if successful,false
otherwise or an sfdc:Error in case of an errorDeprecated
This function is deprecated to rename it. Use the new and improveddelete(string sObjectName, string id)
function instead.
updateContact
Updates existing Contact object record.
Return Type
- Error? -
true
if successful,false
otherwise or an sfdc:Error in case of an errorDeprecated
This function is deprecated as it expects a json payload. Use the new and improvedupdate(string sObjectName, string id, record{} recordPayload)
function instead.
getOpportunityById
Accesses Opportunities SObject records based on the Opportunity object ID.
Return Type
- json|Error - JSON response if successful or else an sfdc:Error
Deprecated
This function is deprecated as it returns a json response. Use the new and improvedgetById(string sObject, string id)
function instead.
createOpportunity
Creates new Opportunity object record.
Parameters
- opportunityRecord json - JSON opportunity record
Return Type
deleteOpportunity
Deletes existing Opportunity's records.
Parameters
- opportunityId string - Opportunity ID
Return Type
- Error? -
true
if successful,false
otherwise or an sfdc:Error in case of an errorDeprecated
This function is deprecated to rename it. Use the new and improveddelete(string sObjectName, string id)
function instead.
updateOpportunity
Updates existing Opportunity object record.
Return Type
- Error? -
true
if successful,false
otherwise or an sfdc:Error in case of an errorDeprecated
This function is deprecated as it expects a json payload. Use the new and improvedupdate(string sObjectName, string id, record{} recordPayload)
function instead.
getProductById
Accesses Products SObject records based on the Product object ID.
Return Type
- json|Error - JSON result if successful or else an sfdc:Error
Deprecated
This function is deprecated as it returns a json response. Use the new and improvedgetById(string sObject, string id)
function instead.
createProduct
Creates new Product object record.
Parameters
- productRecord json - JSON product record
Return Type
deleteProduct
Deletes existing product's records.
Parameters
- productId string - Product ID
Return Type
- Error? -
true
if successful,false
otherwise or an sfdc:Error in case of an errorDeprecated
This function is deprecated to rename it. Use the new and improveddelete(string sObjectName, string id)
function instead.
updateProduct
Updates existing Product object record.
Return Type
- Error? -
true
if successful,false
otherwise or an sfdc:Error in case of an errorDeprecated
This function is deprecated as it expects a json payload. Use the new and improvedupdate(string sObjectName, string id, record{} recordPayload)
function instead.
getQueryResult
function getQueryResult(string receivedQuery) returns SoqlResult|Error
Executes the specified SOQL query.
Parameters
- receivedQuery string - Sent SOQL query
Return Type
- SoqlResult|Error -
SoqlResult
record if successful. Else, the occurredError
.Deprecated
This function is deprecated as it does not handle the pagination of records Use the new and improvedquery(string soql)
function instead.
getNextQueryResult
function getNextQueryResult(string nextRecordsUrl) returns SoqlResult|Error
If the query results are too large, retrieve the next batch of results using the nextRecordUrl.
Parameters
- nextRecordsUrl string - URL to get the next query results
Return Type
- SoqlResult|Error -
SoqlResult
record if successful. Else, the occurredError
.Deprecated
This function is deprecated as it is related to pagination of results inquery(string soql)
Use the new and improvedquery(string soql)
function instead.
getQueryResultStream
Executes the specified SOQL query.
Parameters
- receivedQuery string - Sent SOQL query
Return Type
searchSOSLString
function searchSOSLString(string searchString) returns SoslResult|Error
Executes the specified SOSL search.
Parameters
- searchString string - Sent SOSL search query
Return Type
- SoslResult|Error -
SoslResult
record if successful. Else, the occurredError
.Deprecated
This function is deprecated as it does not handle the pagination of returned data Use the new and improvedsearch(string sosl)
function instead.
searchSOSLStringStream
Executes the specified SOSL search.
Parameters
- searchString string - Sent SOSL search query
Constants
salesforce: API_VERSION
Constant field API_VERSION
. Holds the value for the Salesforce API version.
salesforce: EMPTY_STRING
Constant field EMPTY_STRING
. Holds the value of "".
salesforce: ERR_EXTRACTING_ERROR_MSG
salesforce: HTTP_ERROR_MSG
salesforce: INVALID_CLIENT_CONFIG
Records
salesforce: Attribute
Defines the Attribute type. Contains the attribute information of the resultant record.
Fields
- 'type string -
- url string - URL of the resultant record
salesforce: ConnectionConfig
Salesforce client configuration.
Fields
- baseUrl string - The Salesforce endpoint URL
- clientConfig OAuth2RefreshTokenGrantConfig|BearerTokenConfig - OAuth2 direct token configuration
- secureSocketConfig ClientSecureSocket? - HTTPS secure socket configuration
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
salesforce: ErrorDetails
Additional details extracted from the Http error.
Fields
- statusCode int? - Http status code of the error
- body anydata? - Response body with extra information
salesforce: Limit
Defines the Limit type to list limits information for your org.
Fields
- Max int - The limit total for the org
- Remaining int - The total number of calls or events left for the org
- json... - Rest field
salesforce: OrgMetadata
Metadata for your organization and available to the logged-in user.
Fields
- encoding string - Encoding
- maxBatchSize int - Maximum batch size
- sobjects SObjectMetaData[] - Available SObjects
- json... - Rest field
salesforce: SObjectBasicInfo
Basic info of a SObject.
Fields
- objectDescribe SObjectMetaData - Metadata related to the SObject
- json... - Rest field
salesforce: SObjectMetaData
Metadata for an SObject, including information about each field, URLs, and child relationships.
Fields
- name string - SObject name
- createable boolean - Is createable
- deletable boolean - Is deletable
- updateable boolean - Is updateable
- queryable boolean - Is queryable
- label string - SObject label
- json... - Rest field
salesforce: SoqlRecord
Defines the SOQL query result record type.
Fields
- attributes Attribute - Attribute record
- json... - Rest field
salesforce: SoqlResult
Define the SOQL result type.
Fields
- done boolean - Query is completed or not
- totalSize int - The total number result records
- records SoqlRecord[] - Result records
- json... - Rest field
salesforce: SoslRecord
Defines SOSL query result.
Fields
- attributes Attribute - Attribute record
- Id string - ID of the matching object
- json... - Rest field
salesforce: SoslResult
Defines SOSL query result.
Fields
- searchRecords SoslRecord[] - Matching records for the given search string
- json... - Rest field
salesforce: Version
Defines the Salesforce version type.
Fields
- label string - Label of the Salesforce version
- url string - URL of the Salesforce version
- 'version string -
Errors
salesforce: Error
Salesforce connector error.
Import
import ballerinax/salesforce;
Metadata
Released date: about 2 years ago
Version: 7.0.0
License: Apache-2.0
Compatibility
Platform: java11
Ballerina version: 2201.1.0
Pull count
Total: 1353
Current verison: 7
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Freemium
Contributors