SalesforceClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'GetOnNewItems': {'operation_id': 'GetOnNewItems', 'path': '/{connectionId}/datasets/default/tables/{table}/onnewitems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'ItemsList'}, 'GetOnUpdatedItems': {'operation_id': 'GetOnUpdatedItems', 'path': '/{connectionId}/datasets/default/tables/{table}/onupdateditems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'ItemsList'}}

Classes

TablesList dataclass

TablesList(value: Optional[List[Table]] = None)

Response for Get object types

Attributes

value class-attribute instance-attribute

value: Optional[List[Table]] = None

List of Tables

GetItemByExternalIdResponse dataclass

GetItemByExternalIdResponse(additional_properties: Dict[str, Any] = dict())

Response for Get a Record by External ID

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ItemsList dataclass

ItemsList(value: Optional[List[Item]] = None)

Response for Get records

Attributes

value class-attribute instance-attribute

value: Optional[List[Item]] = None

List of Items

ObjectEntity dataclass

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Response for Execute a SOQL query

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetAllJobsResponse dataclass

GetAllJobsResponse(done: Optional[bool] = None, records: Optional[List[JobInfo]] = None, next_record_url: Optional[str] = None)

Response for Get all jobs

Attributes

done class-attribute instance-attribute

done: Optional[bool] = None

Done

next_record_url class-attribute instance-attribute

next_record_url: Optional[str] = field(default=None, metadata={'wire_name': 'nextRecordUrl'})

Next Record URL

CheckJobResponse dataclass

CheckJobResponse(apex_processing_time: Optional[float] = None, api_active_processing_time: Optional[float] = None, api_version: Optional[float] = None, column_delimiter: Optional[str] = None, concurrency_mode: Optional[str] = None, content_type: Optional[str] = None, content_url: Optional[str] = None, created_by_id: Optional[str] = None, created_date: Optional[str] = None, external_field_name: Optional[str] = None, id: Optional[str] = None, job_type: Optional[str] = None, line_ending: Optional[str] = None, object: Optional[str] = None, operation: Optional[str] = None, retries: Optional[float] = None, state: Optional[str] = None, system_mod_stamp: Optional[str] = None, total_processing_time: Optional[float] = None)

Response for Get job info

Attributes

apex_processing_time class-attribute instance-attribute

apex_processing_time: Optional[float] = field(default=None, metadata={'wire_name': 'apexProcessingTime'})

APEX Processing Time

api_active_processing_time class-attribute instance-attribute

api_active_processing_time: Optional[float] = field(default=None, metadata={'wire_name': 'apiActiveProcessingTime'})

API Active Processing Time

api_version class-attribute instance-attribute

api_version: Optional[float] = field(default=None, metadata={'wire_name': 'apiVersion'})

API Version

column_delimiter class-attribute instance-attribute

column_delimiter: Optional[str] = field(default=None, metadata={'wire_name': 'columnDelimiter'})

Column Delimiter

concurrency_mode class-attribute instance-attribute

concurrency_mode: Optional[str] = field(default=None, metadata={'wire_name': 'concurrencyMode'})

Concurrency Mode

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

Content Type

content_url class-attribute instance-attribute

content_url: Optional[str] = field(default=None, metadata={'wire_name': 'contentUrl'})

Content URL

created_by_id class-attribute instance-attribute

created_by_id: Optional[str] = field(default=None, metadata={'wire_name': 'createdById'})

Created By ID

created_date class-attribute instance-attribute

created_date: Optional[str] = field(default=None, metadata={'wire_name': 'createdDate'})

Created Date

external_field_name class-attribute instance-attribute

external_field_name: Optional[str] = field(default=None, metadata={'wire_name': 'externalFieldName'})

External Field Name

id class-attribute instance-attribute

id: Optional[str] = None

ID

job_type class-attribute instance-attribute

job_type: Optional[str] = field(default=None, metadata={'wire_name': 'jobType'})

Job Type

line_ending class-attribute instance-attribute

line_ending: Optional[str] = field(default=None, metadata={'wire_name': 'lineEnding'})

Line Ending

object class-attribute instance-attribute

object: Optional[str] = None

Object

operation class-attribute instance-attribute

operation: Optional[str] = None

Operation

retries class-attribute instance-attribute

retries: Optional[float] = None

Retries

state class-attribute instance-attribute

state: Optional[str] = None

State

total_processing_time class-attribute instance-attribute

total_processing_time: Optional[float] = field(default=None, metadata={'wire_name': 'totalProcessingTime'})

Total Processing Time

JobInfo dataclass

JobInfo(api_version: Optional[float] = None, column_delimiter: Optional[str] = None, concurrency_mode: Optional[str] = None, content_type: Optional[str] = None, content_url: Optional[str] = None, created_by_id: Optional[str] = None, created_date: Optional[str] = None, external_id_field_name: Optional[str] = None, id: Optional[str] = None, job_type: Optional[str] = None, line_ending: Optional[str] = None, object: Optional[str] = None, operation: Optional[str] = None, state: Optional[str] = None, system_modstamp: Optional[str] = None)

Response for Close or abort a job

Attributes

api_version class-attribute instance-attribute

api_version: Optional[float] = field(default=None, metadata={'wire_name': 'apiVersion'})

API Version

column_delimiter class-attribute instance-attribute

column_delimiter: Optional[str] = field(default=None, metadata={'wire_name': 'columnDelimiter'})

Column Delimiter

concurrency_mode class-attribute instance-attribute

concurrency_mode: Optional[str] = field(default=None, metadata={'wire_name': 'concurrencyMode'})

Concurrency Mode

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

Content Type

content_url class-attribute instance-attribute

content_url: Optional[str] = field(default=None, metadata={'wire_name': 'contentUrl'})

Content URL

created_by_id class-attribute instance-attribute

created_by_id: Optional[str] = field(default=None, metadata={'wire_name': 'createdById'})

Created By ID

created_date class-attribute instance-attribute

created_date: Optional[str] = field(default=None, metadata={'wire_name': 'createdDate'})

Created Date

external_id_field_name class-attribute instance-attribute

external_id_field_name: Optional[str] = field(default=None, metadata={'wire_name': 'externalIdFieldName'})

External ID Field Name

id class-attribute instance-attribute

id: Optional[str] = None

ID

job_type class-attribute instance-attribute

job_type: Optional[str] = field(default=None, metadata={'wire_name': 'jobType'})

Job Type

line_ending class-attribute instance-attribute

line_ending: Optional[str] = field(default=None, metadata={'wire_name': 'lineEnding'})

Line Ending

object class-attribute instance-attribute

object: Optional[str] = None

Object

operation class-attribute instance-attribute

operation: Optional[str] = None

Operation

state class-attribute instance-attribute

state: Optional[str] = None

State

system_modstamp class-attribute instance-attribute

system_modstamp: Optional[str] = field(default=None, metadata={'wire_name': 'systemModstamp'})

System Mod Stamp

SOSLSearchQueryResponse dataclass

SOSLSearchQueryResponse(search_records: Optional[List[SearchRecordObject]] = None, metadata: Optional[Dict[str, Any]] = None)

Response for Execute SOSL search query

Attributes

search_records class-attribute instance-attribute

search_records: Optional[List[SearchRecordObject]] = field(default=None, metadata={'wire_name': 'searchRecords'})

A list of search records returned by an SOSL search query

metadata class-attribute instance-attribute

metadata: Optional[Dict[str, Any]] = None

Metadata of the result returned from the query

ObjectWithoutType dataclass

ObjectWithoutType(additional_properties: Dict[str, Any] = dict())

Response for Send an HTTP request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

MCPQueryResponse dataclass

MCPQueryResponse(jsonrpc: Optional[str] = None, id: Optional[str] = None, method: Optional[str] = None, params: Optional[Dict[str, Any]] = None, result: Optional[Dict[str, Any]] = None, error: Optional[Dict[str, Any]] = None)

Response for MCP server for Salesforce

CreateJobResponse dataclass

CreateJobResponse(object: Optional[str] = None, operation: Optional[str] = None, column_delimiter: Optional[str] = None, external_id_field_name: Optional[str] = None, line_ending: Optional[str] = None, content_type: Optional[str] = None, api_version: Optional[float] = None, concurrency_mode: Optional[str] = None, content_url: Optional[str] = None, created_by_id: Optional[str] = None, created_date: Optional[str] = None, id: Optional[str] = None, job_type: Optional[str] = None, state: Optional[str] = None, system_modstamp: Optional[str] = None)

Response for Create a job

Attributes

object class-attribute instance-attribute

object: Optional[str] = None

The object type for the data being processed.

operation class-attribute instance-attribute

operation: Optional[str] = None

The processing operation for the job.

column_delimiter class-attribute instance-attribute

column_delimiter: Optional[str] = field(default=None, metadata={'wire_name': 'columnDelimiter'})

The column delimiter used for CSV job data.

external_id_field_name class-attribute instance-attribute

external_id_field_name: Optional[str] = field(default=None, metadata={'wire_name': 'externalIdFieldName'})

The external ID field in the object being updated. Only needed for upsert operations. Field values must also exist in CSV job data.

line_ending class-attribute instance-attribute

line_ending: Optional[str] = field(default=None, metadata={'wire_name': 'lineEnding'})

The line ending used for CSV job data, marking the end of a data row.

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

The content type for the job.

api_version class-attribute instance-attribute

api_version: Optional[float] = field(default=None, metadata={'wire_name': 'apiVersion'})

The API version that the job was created in.

concurrency_mode class-attribute instance-attribute

concurrency_mode: Optional[str] = field(default=None, metadata={'wire_name': 'concurrencyMode'})

The concurrency mode for the job.

content_url class-attribute instance-attribute

content_url: Optional[str] = field(default=None, metadata={'wire_name': 'contentUrl'})

The URL to use for Upload Job Data requests for this job. Only valid if the job is in 'Open' state.

created_by_id class-attribute instance-attribute

created_by_id: Optional[str] = field(default=None, metadata={'wire_name': 'createdById'})

The ID of the user who created the job.

created_date class-attribute instance-attribute

created_date: Optional[str] = field(default=None, metadata={'wire_name': 'createdDate'})

The date and time in the UTC time zone when the job was created.

id class-attribute instance-attribute

id: Optional[str] = None

Unique ID for this job.

job_type class-attribute instance-attribute

job_type: Optional[str] = field(default=None, metadata={'wire_name': 'jobType'})

The job's type.

state class-attribute instance-attribute

state: Optional[str] = None

The current state of processing for the job.

system_modstamp class-attribute instance-attribute

system_modstamp: Optional[str] = field(default=None, metadata={'wire_name': 'systemModstamp'})

Date and time in the UTC time zone when the job finished.

GetItemResponse dataclass

GetItemResponse(additional_properties: Dict[str, Any] = dict())

Response for Get record

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PatchItemInput dataclass

PatchItemInput(additional_properties: Dict[str, Any] = dict())

Update record

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PatchItemResponse dataclass

PatchItemResponse(additional_properties: Dict[str, Any] = dict())

Response for Update record

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PatchItemByExternalIdInput dataclass

PatchItemByExternalIdInput(additional_properties: Dict[str, Any] = dict())

Insert or Update (Upsert) a Record by External ID

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PatchItemByExternalIdResponse dataclass

PatchItemByExternalIdResponse(additional_properties: Dict[str, Any] = dict())

Response for Insert or Update (Upsert) a Record by External ID

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PostItemInput dataclass

PostItemInput(additional_properties: Dict[str, Any] = dict())

Create record

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PostItemResponse dataclass

PostItemResponse(additional_properties: Dict[str, Any] = dict())

Response for Create record

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ExternalIdFieldsList dataclass

ExternalIdFieldsList(value: Optional[List[ExternalIdField]] = None)

Response for Get External ID Fields

Attributes

value class-attribute instance-attribute

value: Optional[List[ExternalIdField]] = None

List of external ID fields.

TableMetadata dataclass

TableMetadata(name: Optional[str] = None, title: Optional[str] = None, x_ms_permission: Optional[str] = None, x_ms_capabilities: Optional[TableCapabilitiesMetadata] = None, schema: Optional[ObjectEntity] = None, referenced_entities: Optional[ObjectEntity] = None, web_url: Optional[str] = None)

Response for GetMetadataForGetItem

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Table name

title class-attribute instance-attribute

title: Optional[str] = None

Table title

x_ms_permission class-attribute instance-attribute

x_ms_permission: Optional[str] = field(default=None, metadata={'wire_name': 'x-ms-permission'})

Table permission

web_url class-attribute instance-attribute

web_url: Optional[str] = field(default=None, metadata={'wire_name': 'webUrl'})

URL link

BlobDataSetsMetadata dataclass

BlobDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Blob dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Blob dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Blob dataset url encoding

CreateJobParameters dataclass

CreateJobParameters(object: Optional[str] = None, operation: Optional[str] = None, column_delimiter: Optional[str] = None, external_id_field_name: Optional[str] = None, line_ending: Optional[str] = None, content_type: Optional[str] = None)

Definition: CreateJobParameters

Attributes

object class-attribute instance-attribute

object: Optional[str] = None

The object type for the data being processed.

operation class-attribute instance-attribute

operation: Optional[str] = None

The processing operation for the job.

column_delimiter class-attribute instance-attribute

column_delimiter: Optional[str] = field(default=None, metadata={'wire_name': 'columnDelimiter'})

The column delimiter used for CSV job data.

external_id_field_name class-attribute instance-attribute

external_id_field_name: Optional[str] = field(default=None, metadata={'wire_name': 'externalIdFieldName'})

The external ID field in the object being updated. Only needed for upsert operations. Field values must also exist in CSV job data.

line_ending class-attribute instance-attribute

line_ending: Optional[str] = field(default=None, metadata={'wire_name': 'lineEnding'})

The line ending used for CSV job data, marking the end of a data row.

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

The content type for the job.

DataSet dataclass

DataSet(name: Optional[str] = None, display_name: Optional[str] = None, query: Optional[List[PassThroughNativeQuery]] = None)

Definition: DataSet

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Dataset name

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Dataset display name

query class-attribute instance-attribute

query: Optional[List[PassThroughNativeQuery]] = None

Pass-through Native Queries

DataSetsList dataclass

DataSetsList(value: Optional[List[DataSet]] = None)

Definition: DataSetsList

Attributes

value class-attribute instance-attribute

value: Optional[List[DataSet]] = None

List of datasets

DataSetsMetadata dataclass

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = None)

Definition: DataSetsMetadata

ExecuteSoqlQueryParameters dataclass

ExecuteSoqlQueryParameters(query: Optional[str] = None, parameters: Optional[Dict[str, Any]] = None)

Definition: ExecuteSoqlQueryParameters

Attributes

query class-attribute instance-attribute

query: Optional[str] = None

SOQL Query text. Dynamic parameters can be specified using '@paramName' syntax.

parameters class-attribute instance-attribute

parameters: Optional[Dict[str, Any]] = None

SOQL Query dynamic parameters. Key is parameter name (without '@' at sign), value is parameter value.

ExternalIdField dataclass

ExternalIdField(name: Optional[str] = None, display_name: Optional[str] = None)

Definition: ExternalIdField

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Name of the external ID field, used at runtime.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Display name of the external ID field.

Item dataclass

Item(dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: Item

PassThroughNativeQuery dataclass

PassThroughNativeQuery(language: Optional[str] = None)

Definition: PassThroughNativeQuery

Attributes

language class-attribute instance-attribute

language: Optional[str] = field(default=None, metadata={'wire_name': 'Language'})

Query language

Procedure dataclass

Procedure(name: Optional[str] = None, display_name: Optional[str] = None)

Definition: Procedure

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Procedure name

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Procedure display name

Table dataclass

Table(name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: Table

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

The name of the table. The name is used at runtime.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DynamicProperties'})

Additional table properties provided by the connector to the clients.

TableCapabilitiesMetadata dataclass

TableCapabilitiesMetadata(sort_restrictions: Optional[TableSortRestrictionsMetadata] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata] = None, is_only_server_pagable: Optional[bool] = None, filter_function_support: Optional[List[str]] = None, server_paging_options: Optional[List[str]] = None)

Definition: TableCapabilitiesMetadata

Attributes

is_only_server_pagable class-attribute instance-attribute

is_only_server_pagable: Optional[bool] = field(default=None, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute

filter_function_support: Optional[List[str]] = field(default=None, metadata={'wire_name': 'filterFunctionSupport'})

List of supported filter capabilities

server_paging_options class-attribute instance-attribute

server_paging_options: Optional[List[str]] = field(default=None, metadata={'wire_name': 'serverPagingOptions'})

List of supported server-driven paging capabilities

TableFilterRestrictionsMetadata dataclass

TableFilterRestrictionsMetadata(filterable: Optional[bool] = None, non_filterable_properties: Optional[List[str]] = None, required_properties: Optional[List[str]] = None)

Definition: TableFilterRestrictionsMetadata

Attributes

filterable class-attribute instance-attribute

filterable: Optional[bool] = None

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute

non_filterable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'nonFilterableProperties'})

List of non filterable properties

required_properties class-attribute instance-attribute

required_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'requiredProperties'})

List of required properties

TableSelectRestrictionsMetadata dataclass

TableSelectRestrictionsMetadata(selectable: Optional[bool] = None)

Definition: TableSelectRestrictionsMetadata

Attributes

selectable class-attribute instance-attribute

selectable: Optional[bool] = None

Indicates whether this table has selectable columns

TableSortRestrictionsMetadata dataclass

TableSortRestrictionsMetadata(sortable: Optional[bool] = None, unsortable_properties: Optional[List[str]] = None, ascending_only_properties: Optional[List[str]] = None)

Definition: TableSortRestrictionsMetadata

Attributes

sortable class-attribute instance-attribute

sortable: Optional[bool] = None

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute

unsortable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'unsortableProperties'})

List of unsortable properties

ascending_only_properties class-attribute instance-attribute

ascending_only_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'ascendingOnlyProperties'})

List of properties which support ascending order only

TabularDataSetsMetadata dataclass

TabularDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Dataset url encoding

table_display_name class-attribute instance-attribute

table_display_name: Optional[str] = field(default=None, metadata={'wire_name': 'tableDisplayName'})

Table display name

table_plural_name class-attribute instance-attribute

table_plural_name: Optional[str] = field(default=None, metadata={'wire_name': 'tablePluralName'})

Table plural display name

CreateJobRequest dataclass

CreateJobRequest(column_delimiter: Optional[str] = None, external_id_field_name: Optional[str] = None, line_ending: Optional[str] = None, object: Optional[str] = None, operation: Optional[str] = None)

Definition: CreateJobRequest

Attributes

column_delimiter class-attribute instance-attribute

column_delimiter: Optional[str] = field(default=None, metadata={'wire_name': 'columnDelimiter'})

Column Delimiter

external_id_field_name class-attribute instance-attribute

external_id_field_name: Optional[str] = field(default=None, metadata={'wire_name': 'externalIdFieldName'})

External ID Field Name

line_ending class-attribute instance-attribute

line_ending: Optional[str] = field(default=None, metadata={'wire_name': 'lineEnding'})

Line Ending

object class-attribute instance-attribute

object: Optional[str] = None

Object

operation class-attribute instance-attribute

operation: Optional[str] = None

Operation

InstanceUrlResponse dataclass

InstanceUrlResponse(instance_url: Optional[str] = None)

Definition: InstanceUrlResponse

Attributes

instance_url class-attribute instance-attribute

instance_url: Optional[str] = field(default=None, metadata={'wire_name': 'instanceUrl'})

Instance Url

GetCurrentUserInfoResponse dataclass

GetCurrentUserInfoResponse(additional_properties: Dict[str, Any] = dict())

Definition: GetCurrentUserInfoResponse

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SearchRecordObject dataclass

SearchRecordObject(attributes: Optional[Dict[str, Any]] = None, id: Optional[str] = None)

Definition: SearchRecordObject

Attributes

attributes class-attribute instance-attribute

attributes: Optional[Dict[str, Any]] = None

Attributes of a search record

id class-attribute instance-attribute

id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

Unique identifier of the record

CloseJobRequest dataclass

CloseJobRequest(state: Optional[str] = None)

Definition: CloseJobRequest

Attributes

state class-attribute instance-attribute

state: Optional[str] = None

state

MCPQueryRequest dataclass

MCPQueryRequest(jsonrpc: Optional[str] = None, id: Optional[str] = None, method: Optional[str] = None, params: Optional[Dict[str, Any]] = None, result: Optional[Dict[str, Any]] = None, error: Optional[Dict[str, Any]] = None, callback_endpoint: Optional[str] = None)

Definition: MCPQueryRequest

SalesforceClient

SalesforceClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for salesforce connector.

Initialize a SalesforceClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

get_tables_async async

get_tables_async() -> dict[str, Any] | None

Get object types

This operation lists the available Salesforce object types.

get_item_by_external_id_async async

get_item_by_external_id_async(table: str, external_id_field: str, external_id: str) -> dict[str, Any] | None

Get a Record by External ID

This operation retrieves a record using an external ID.

get_items_async async

get_items_async(table: str, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None) -> dict[str, Any] | None

Get records

This operation gets records of a certain Salesforce object type like 'Leads'.

get_items_table_account_async async

get_items_table_account_async(filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None) -> dict[str, Any] | None

Get Account records from Salesforce

This operation gets Account records from Salesforce.

get_items_table_user_async async

get_items_table_user_async(filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None) -> dict[str, Any] | None

Get User records from Salesforce

This operation gets User records from Salesforce.

get_items_table_case_async async

get_items_table_case_async(filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None) -> dict[str, Any] | None

Get Case records from Salesforce

This operation gets Case records from Salesforce.

get_items_table_opportunity_async async

get_items_table_opportunity_async(filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None) -> dict[str, Any] | None

Get Opportunity records from Salesforce

This operation gets Opportunity records from Salesforce.

get_items_table_product2_async async

get_items_table_product2_async(filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None) -> dict[str, Any] | None

Get Product records from Salesforce

This operation gets Product records from Salesforce.

get_items_table_contact_async async

get_items_table_contact_async(filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None) -> dict[str, Any] | None

Get Contact records from Salesforce

This operation gets Contact records from Salesforce.

delete_item_async async

delete_item_async(table: str, id: str) -> None

Delete record

This operation deletes a record.

execute_soql_query_async async

execute_soql_query_async(input: ExecuteSoqlQueryParameters) -> dict[str, Any] | None

Execute a SOQL query

Execute a SOQL query.

get_all_jobs_async async

get_all_jobs_async(concurreny_mode: Optional[str] = None, is_pk_chunking_enabled: Optional[bool] = None, job_type: Optional[str] = None, query_locator: Optional[str] = None) -> dict[str, Any] | None

Get all jobs

Get a list of all jobs

upload_job_data_async async

upload_job_data_async(input: bytes, job_id: str) -> None

Upload job data

Uploads data for a job using CSV data.

get_job_info_async async

get_job_info_async(job_id: str) -> dict[str, Any] | None

Get job info

Retrieves detailed information about a job.

close_job_async async

close_job_async(input: CloseJobRequest, job_id: str) -> dict[str, Any] | None

Close or abort a job

Closes or aborts a job. Use UploadComplete to close a job, or Aborted to abort a job. If you close a job, Salesforce queues the job and uploaded data for processing, and you can't add any additional job data. If you abort a job, the job does not get queued or processed.

delete_job_async async

delete_job_async(job_id: str) -> None

Delete a job

Deletes a job. To be deleted, a job must have a state of UploadComplete, JobComplete, Aborted, or Failed.

get_job_record_results_async async

get_job_record_results_async(job_id: str, result_type: str) -> dict[str, Any] | None

Get job results

Retrieves a list of records based on the result type for a completed job.

execute_sosl_query_async async

execute_sosl_query_async(q: str) -> dict[str, Any] | None

Execute SOSL search query

Execute the specified SOSL search qyery

http_request_async async

http_request_async(input: bytes) -> dict[str, Any] | None

Send an HTTP request

Construct a Salesforce REST API request to invoke

mcp_salesforce_management_async async

mcp_salesforce_management_async(input: MCPQueryRequest, session_id: Optional[str] = None) -> dict[str, Any] | None

MCP server for Salesforce

MCP server for Salesforce

create_job_async async

create_job_async(input: CreateJobParameters) -> dict[str, Any] | None

Create a job

Creates a job, which represents a bulk operation (and associated data) that is sent to Salesforce for asynchronous processing. Provide job data via an Upload Job Data request.

get_item_async async

get_item_async(table: str, id: str, select: Optional[str] = None) -> dict[str, Any] | None

Get record

This operation gets a record.

patch_item_async async

patch_item_async(input: PatchItemInput, table: str, id: str, select: Optional[str] = None) -> dict[str, Any] | None

Update record

This operation updates a record and allows null values.

patch_item_by_external_id_async async

patch_item_by_external_id_async(input: PatchItemByExternalIdInput, table: str, external_id_field: str, external_id: str) -> dict[str, Any] | None

Insert or Update (Upsert) a Record by External ID

This operation inserts or updates (upserts) a record using an external ID.

post_item_async async

post_item_async(input: PostItemInput, table: str) -> dict[str, Any] | None

Create record

This operation creates a record and allows null values.

get_external_id_fields_async async

get_external_id_fields_async(table: str) -> dict[str, Any] | None

Get External ID Fields

This operation retrieves external ID fields of Salesforce object type.

get_metadata_for_get_item_async async

get_metadata_for_get_item_async(table: str) -> dict[str, Any] | None

GetMetadataForGetItem

get_metadata_for_patch_item_async async

get_metadata_for_patch_item_async(table: str) -> dict[str, Any] | None

GetMetadataForPatchItem

get_metadata_for_post_item_async async

get_metadata_for_post_item_async(table: str) -> dict[str, Any] | None

GetMetadataForPostItem

get_table_async async

get_table_async(table: str) -> dict[str, Any] | None

Get object metadata

This operation gets the object metadata for a Salesforce object type.