Ballerina library

salesforce

Modules

salesforce

salesforce.bulksalesforce.restsalesforce.soap

Module salesforce

API

Client

Declarations

API_VERSION
EMPTY_STRING
ERR_EXTRACTING_ERROR_MSG
HTTP_ERROR_MSG
INVALID_CLIENT_CONFIG

Definitions

Attribute
ConnectionConfig
ErrorDetails
Limit
OrgMetadata
SObjectBasicInfo
SObjectMetaData
SoqlRecord
SoqlResult
SoslRecord
SoslResult
Version

Error

ballerinax/salesforce Ballerina library

7.0.0

Clients

salesforce: Client

DeprecatedIsolated

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)

describeAvailableObjects

DeprecatedIsolated FunctionRemote Function
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 else sfdc:Error

    Deprecated

    This function is deprecated as the salesforce client is deprecated. Use the describeAvailableObjects function in salesforce.rest client instead.

getSObjectBasicInfo

DeprecatedIsolated FunctionRemote Function
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 else sfdc:Error

    Deprecated

    This function is deprecated as the salesforce client is deprecated. Use the getSObjectBasicInfo function in salesforce.rest client instead.

describeSObject

DeprecatedIsolated FunctionRemote Function
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 else sfdc:Error

    Deprecated

    This function is deprecated as the salesforce client is deprecated. Use the describeSObject function in salesforce.rest client instead.

sObjectPlatformAction

DeprecatedIsolated FunctionRemote Function
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 else sfdc:Error

    Deprecated

    This function is deprecated as the salesforce client is deprecated. Use the sObjectPlatformAction function in salesforce.rest client instead.

getAvailableApiVersions

DeprecatedIsolated FunctionRemote Function
function getAvailableApiVersions() returns Version[]|Error

Lists summary details about each REST API version available.

Return Type
  • Version[]|Error - List of Version if successful. Else, the occured Error.

    Deprecated

    This function is deprecated as the salesforce client is deprecated. Use the getAvailableApiVersions function in salesforce.rest client instead.

getResourcesByApiVersion

DeprecatedIsolated FunctionRemote Function
function getResourcesByApiVersion(string apiVersion) returns map<string>|Error

Lists the resources available for the specified API version.

Parameters
  • apiVersion string - API version (v37)
Return Type
  • map<string>|Error - Resources as map of strings if successful. Else, the occurred Error.

    Deprecated

    This function is deprecated as the salesforce client is deprecated. Use the getResourcesByApiVersion function in salesforce.rest client instead.

getOrganizationLimits

DeprecatedIsolated FunctionRemote Function
function getOrganizationLimits() returns map<Limit>|Error

Lists the Limits information for your organization.

Return Type
  • map<Limit>|Error - OrganizationLimits as map of Limit if successful. Else, the occurred Error.

    Deprecated

    This function is deprecated as the salesforce client is deprecated. Use the getOrganizationLimits function in salesforce.rest client instead.

getRecord

DeprecatedIsolated FunctionRemote Function
function getRecord(string path) returns json|Error

Accesses records based on the specified object ID, can be used with external objects.

Parameters
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 improved getById(string sObject, string id) function instead.

getRecordById

DeprecatedIsolated FunctionRemote Function
function getRecordById(string sobject, string id, string... fields) returns json|Error

Gets an object record by ID.

Parameters
  • sobject string - SObject name
  • 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 improved getById(string sObject, string id) function instead.

getRecordByExtId

DeprecatedIsolated FunctionRemote Function
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 improved getByExternalId(string sObject, string extIdField, string extId) function instead.

createRecord

DeprecatedIsolated FunctionRemote Function
function createRecord(string sObjectName, json recordPayload) returns string|Error

Creates records based on relevant object type sent with json record.

Parameters
  • sObjectName string - SObject name value
  • recordPayload json - JSON record to be inserted
Return Type
  • string|Error - Created entity ID if successful or else sfdc:Error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved create(string sObjectName, record{} recordPayload) function instead.

deleteRecord

DeprecatedIsolated FunctionRemote Function
function deleteRecord(string sObjectName, string id) returns Error?

Delete existing records based on relevant object ID.

Parameters
  • sObjectName string - SObject name value
Return Type
  • Error? - true if successful else false or else sfdc:Error

    Deprecated

    This function is deprecated to rename it. Use the new and improved delete(string sObjectName, string id) function instead.

updateRecord

DeprecatedIsolated FunctionRemote Function
function updateRecord(string sObjectName, string id, json recordPayload) returns Error?

Updates records based on relevant object ID.

Parameters
  • sObjectName string - SObject name value
  • 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 improved update(string sObjectName, string id, record{} recordPayload) function instead.

getAccountById

DeprecatedIsolated FunctionRemote Function
function getAccountById(string accountId, string... fields) returns json|Error

Accesses Account SObject records based on the Account object ID.

Parameters
  • accountId string - Account ID
  • fields string... - Fields to retireve
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 improved getById(string sObject, string id) function instead.

createAccount

DeprecatedIsolated FunctionRemote Function
function createAccount(json accountRecord) returns string|Error

Creates new Account object record.

Parameters
  • accountRecord json - Account JSON record to be inserted
Return Type
  • string|Error - Account ID if successful or else an sfdc:Error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved create(string sObjectName, record{} recordPayload) function instead.

deleteAccount

DeprecatedIsolated FunctionRemote Function
function deleteAccount(string accountId) returns Error?

Deletes existing Account's records.

Parameters
  • accountId string - Account ID
Return Type
  • Error? - true if successful false otherwise, or an sfdc:Error in case of an error

    Deprecated

    This function is deprecated to rename it. Use the new and improved delete(string sObjectName, string id) function instead.

updateAccount

DeprecatedIsolated FunctionRemote Function
function updateAccount(string accountId, json accountRecord) returns Error?

Updates existing Account object record.

Parameters
  • accountId string - Account ID
  • accountRecord json - Account record JSON payload
Return Type
  • Error? - true if successful, false otherwise or an sfdc:Error in case of an error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved update(string sObjectName, string id, record{} recordPayload) function instead.

getLeadById

DeprecatedIsolated FunctionRemote Function
function getLeadById(string leadId, string... fields) returns json|Error

Accesses Lead SObject records based on the Lead object ID.

Parameters
  • fields string... - Fields to retireve
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 improved getById(string sObject, string id) function instead.

createLead

DeprecatedIsolated FunctionRemote Function
function createLead(json leadRecord) returns string|Error

Creates new Lead object record.

Parameters
  • leadRecord json - Lead JSON record to be inserted
Return Type
  • string|Error - Lead ID if successful or else an sfdc:Error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved create(string sObjectName, record{} recordPayload) function instead.

deleteLead

DeprecatedIsolated FunctionRemote Function
function deleteLead(string leadId) returns Error?

Deletes existing Lead's records.

Parameters
Return Type
  • Error? - true if successful, false otherwise or an sfdc:Error incase of an error

    Deprecated

    This function is deprecated to rename it. Use the new and improved delete(string sObjectName, string id) function instead.

updateLead

DeprecatedIsolated FunctionRemote Function
function updateLead(string leadId, json leadRecord) returns Error?

Updates existing Lead object record.

Parameters
  • leadRecord json - Lead JSON record
Return Type
  • Error? - true if successful, false otherwise or an sfdc:Error in case of an error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved update(string sObjectName, string id, record{} recordPayload) function instead.

getContactById

DeprecatedIsolated FunctionRemote Function
function getContactById(string contactId, string... fields) returns json|Error

Accesses Contacts SObject records based on the Contact object ID.

Parameters
  • contactId string - Contact ID
  • fields string... - Fields to retireve
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 improved getById(string sObject, string id) function instead.

createContact

DeprecatedIsolated FunctionRemote Function
function createContact(json contactRecord) returns string|Error

Creates new Contact object record.

Parameters
  • contactRecord json - JSON contact record
Return Type
  • string|Error - Contact ID if successful or else an sfdc:Error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved create(string sObjectName, record{} recordPayload) function instead.

deleteContact

DeprecatedIsolated FunctionRemote Function
function deleteContact(string contactId) returns Error?

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 error

    Deprecated

    This function is deprecated to rename it. Use the new and improved delete(string sObjectName, string id) function instead.

updateContact

DeprecatedIsolated FunctionRemote Function
function updateContact(string contactId, json contactRecord) returns Error?

Updates existing Contact object record.

Parameters
  • contactId string - Contact ID
  • contactRecord json - JSON contact record
Return Type
  • Error? - true if successful, false otherwise or an sfdc:Error in case of an error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved update(string sObjectName, string id, record{} recordPayload) function instead.

getOpportunityById

DeprecatedIsolated FunctionRemote Function
function getOpportunityById(string opportunityId, string... fields) returns json|Error

Accesses Opportunities SObject records based on the Opportunity object ID.

Parameters
  • opportunityId string - Opportunity ID
  • fields string... - Fields to retireve
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 improved getById(string sObject, string id) function instead.

createOpportunity

DeprecatedIsolated FunctionRemote Function
function createOpportunity(json opportunityRecord) returns string|Error

Creates new Opportunity object record.

Parameters
  • opportunityRecord json - JSON opportunity record
Return Type
  • string|Error - Opportunity ID if successful or else an sfdc:Error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved create(string sObjectName, record{} recordPayload) function instead.

deleteOpportunity

DeprecatedIsolated FunctionRemote Function
function deleteOpportunity(string opportunityId) returns Error?

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 error

    Deprecated

    This function is deprecated to rename it. Use the new and improved delete(string sObjectName, string id) function instead.

updateOpportunity

DeprecatedIsolated FunctionRemote Function
function updateOpportunity(string opportunityId, json opportunityRecord) returns Error?

Updates existing Opportunity object record.

Parameters
  • opportunityId string - Opportunity ID
  • opportunityRecord json - Opportunity JSON payload
Return Type
  • Error? - true if successful, false otherwise or an sfdc:Error in case of an error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved update(string sObjectName, string id, record{} recordPayload) function instead.

getProductById

DeprecatedIsolated FunctionRemote Function
function getProductById(string productId, string... fields) returns json|Error

Accesses Products SObject records based on the Product object ID.

Parameters
  • productId string - Product ID
  • fields string... - Fields to retireve
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 improved getById(string sObject, string id) function instead.

createProduct

DeprecatedIsolated FunctionRemote Function
function createProduct(json productRecord) returns string|Error

Creates new Product object record.

Parameters
  • productRecord json - JSON product record
Return Type
  • string|Error - Product ID if successful or else an sfdc:Error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved create(string sObjectName, record{} recordPayload) function instead.

deleteProduct

DeprecatedIsolated FunctionRemote Function
function deleteProduct(string productId) returns Error?

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 error

    Deprecated

    This function is deprecated to rename it. Use the new and improved delete(string sObjectName, string id) function instead.

updateProduct

DeprecatedIsolated FunctionRemote Function
function updateProduct(string productId, json productRecord) returns Error?

Updates existing Product object record.

Parameters
  • productId string - Product ID
  • productRecord json - JSON product record
Return Type
  • Error? - true if successful, false otherwise or an sfdc:Error in case of an error

    Deprecated

    This function is deprecated as it expects a json payload. Use the new and improved update(string sObjectName, string id, record{} recordPayload) function instead.

getQueryResult

DeprecatedIsolated FunctionRemote Function
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 occurred Error.

    Deprecated

    This function is deprecated as it does not handle the pagination of records Use the new and improved query(string soql) function instead.

getNextQueryResult

DeprecatedIsolated FunctionRemote Function
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 occurred Error.

    Deprecated

    This function is deprecated as it is related to pagination of results in query(string soql) Use the new and improved query(string soql) function instead.

getQueryResultStream

DeprecatedIsolated FunctionRemote Function
function getQueryResultStream(string receivedQuery) returns stream<record {}, error?>|error

Executes the specified SOQL query.

Parameters
  • receivedQuery string - Sent SOQL query
Return Type
  • stream<record {}, error?>|error - SoqlResult record if successful. Else, the occurred error.

    Deprecated

    This function is deprecated as it does not handle the pagination of records Use the new and improved query(string soql) function instead.

searchSOSLString

DeprecatedIsolated FunctionRemote Function
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 occurred Error.

    Deprecated

    This function is deprecated as it does not handle the pagination of returned data Use the new and improved search(string sosl) function instead.

searchSOSLStringStream

DeprecatedIsolated FunctionRemote Function
function searchSOSLStringStream(string searchString) returns stream<record {}, error?>|error

Executes the specified SOSL search.

Parameters
  • searchString string - Sent SOSL search query
Return Type
  • stream<record {}, error?>|error - stream<record{}, error?> record if successful. Else, the occurred error.

    Deprecated

    This function is deprecated as it does not handle the pagination of returned data Use the new and improved search(string sosl) function instead.

Constants

salesforce: API_VERSION

string "v48.0"

Constant field API_VERSION. Holds the value for the Salesforce API version.

salesforce: EMPTY_STRING

string ""

Constant field EMPTY_STRING. Holds the value of "".

salesforce: ERR_EXTRACTING_ERROR_MSG

string "Error occured while extracting errors from payload."

salesforce: HTTP_ERROR_MSG

string "Error occurred while getting the HTTP response."

salesforce: INVALID_CLIENT_CONFIG

string "Invalid values provided for client configuration parameters."

Records

salesforce: Attribute

Closed record

Defines the Attribute type. Contains the attribute information of the resultant record.

Fields
  • url string - URL of the resultant record

salesforce: ConnectionConfig

Closed record

Salesforce client configuration.

Fields
  • baseUrl string - The Salesforce endpoint URL
  • httpVersion string(default "1.1") - The HTTP version understood by the client
  • 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
  • headers map<string[]>? - Http headers in the error response
  • 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
  • maxBatchSize int - Maximum batch size
  • json... - Rest field

salesforce: SObjectBasicInfo

Basic info of a SObject.

Fields
  • json... - Rest field

salesforce: SObjectMetaData

Metadata for an SObject, including information about each field, URLs, and child relationships.

Fields
  • json... - Rest field

salesforce: SoqlRecord

Defines the SOQL query result record type.

Fields
  • 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
  • json... - Rest field

salesforce: SoslRecord

Defines SOSL query result.

Fields
  • 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

Closed record

Defines the Salesforce version type.

Fields
  • label string - Label of the Salesforce version
  • url string - URL of the Salesforce version

Errors

salesforce: Error

ErrorDetails

Salesforce connector error.

Import

import ballerinax/salesforce;Copy

Other versions

8.2.08.1.08.0.38.0.28.0.1
See more...

Metadata

Released date: about 3 years ago

Version: 7.0.0

License: Apache-2.0

Compatibility

Platform: java11

Ballerina version: 2201.1.0

Pull count

Total: 96317

Current verison: 925

Weekly downloads

Source repository

Keywords

Sales & CRM/Customer Relationship Management

Cost/Freemium

Contributors

Dependencies

ballerina/io/1.2.2ballerina/url/2.2.2ballerina/regex/1.3.0
See more...

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC