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 | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Get object types

Attributes

value class-attribute instance-attribute

value: Optional[List[Table | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Tables

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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] = dataclass_field(default_factory=dict, kw_only=True)

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

ItemsList dataclass

ItemsList(*, value: Optional[List[Item | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Get records

Attributes

value class-attribute instance-attribute

value: Optional[List[Item | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Items

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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] = dataclass_field(default_factory=dict, kw_only=True)

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

GetAllJobsResponse dataclass

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

Response for Get all jobs

Attributes

done class-attribute instance-attribute

done: Optional[bool] = dataclass_field(default=None, kw_only=True)

Done

next_record_url class-attribute instance-attribute

next_record_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'apexProcessingTime'})

APEX Processing Time

api_active_processing_time class-attribute instance-attribute

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

API Active Processing Time

api_version class-attribute instance-attribute

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

API Version

column_delimiter class-attribute instance-attribute

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

Column Delimiter

concurrency_mode class-attribute instance-attribute

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

Concurrency Mode

content_type class-attribute instance-attribute

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

Content Type

content_url class-attribute instance-attribute

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

Content URL

created_by_id class-attribute instance-attribute

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

Created By ID

created_date class-attribute instance-attribute

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

Created Date

external_field_name class-attribute instance-attribute

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

External Field Name

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

ID

job_type class-attribute instance-attribute

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

Job Type

line_ending class-attribute instance-attribute

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

Line Ending

object class-attribute instance-attribute

object: Optional[str] = dataclass_field(default=None, kw_only=True)

Object

operation class-attribute instance-attribute

operation: Optional[str] = dataclass_field(default=None, kw_only=True)

Operation

retries class-attribute instance-attribute

retries: Optional[float] = dataclass_field(default=None, kw_only=True)

Retries

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

State

total_processing_time class-attribute instance-attribute

total_processing_time: Optional[float] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'apiVersion'})

API Version

column_delimiter class-attribute instance-attribute

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

Column Delimiter

concurrency_mode class-attribute instance-attribute

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

Concurrency Mode

content_type class-attribute instance-attribute

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

Content Type

content_url class-attribute instance-attribute

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

Content URL

created_by_id class-attribute instance-attribute

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

Created By ID

created_date class-attribute instance-attribute

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

Created Date

external_id_field_name class-attribute instance-attribute

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

External ID Field Name

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

ID

job_type class-attribute instance-attribute

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

Job Type

line_ending class-attribute instance-attribute

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

Line Ending

object class-attribute instance-attribute

object: Optional[str] = dataclass_field(default=None, kw_only=True)

Object

operation class-attribute instance-attribute

operation: Optional[str] = dataclass_field(default=None, kw_only=True)

Operation

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

State

system_modstamp class-attribute instance-attribute

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

System Mod Stamp

SOSLSearchQueryResponse dataclass

SOSLSearchQueryResponse(*, search_records: Optional[List[SearchRecordObject | Mapping[str, Any]]] = 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 | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, 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]] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The object type for the data being processed.

operation class-attribute instance-attribute

operation: Optional[str] = dataclass_field(default=None, kw_only=True)

The processing operation for the job.

column_delimiter class-attribute instance-attribute

column_delimiter: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentType'})

The content type for the job.

api_version class-attribute instance-attribute

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

The API version that the job was created in.

concurrency_mode class-attribute instance-attribute

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

The concurrency mode for the job.

content_url class-attribute instance-attribute

content_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdById'})

The ID of the user who created the job.

created_date class-attribute instance-attribute

created_date: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

Unique ID for this job.

job_type class-attribute instance-attribute

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

The job's type.

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

The current state of processing for the job.

system_modstamp class-attribute instance-attribute

system_modstamp: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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

ExternalIdFieldsList dataclass

ExternalIdFieldsList(*, value: Optional[List[ExternalIdField | Mapping[str, Any]]] = None)

Response for Get External ID Fields

Attributes

value class-attribute instance-attribute

value: Optional[List[ExternalIdField | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

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 | Mapping[str, Any]] = None, schema: Optional[ObjectEntity | Mapping[str, Any]] = None, referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = None, web_url: Optional[str] = None)

Response for GetMetadataForGetItem

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Table name

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Table title

x_ms_permission class-attribute instance-attribute

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

Table permission

web_url class-attribute instance-attribute

web_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

Blob dataset source

display_name class-attribute instance-attribute

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

Blob dataset display name

url_encoding class-attribute instance-attribute

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

Blob dataset url encoding

CreateJobParameters dataclass

CreateJobParameters(object: str, operation: str, *, 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 instance-attribute

object: str

The object type for the data being processed.

operation instance-attribute

operation: str

The processing operation for the job.

column_delimiter class-attribute instance-attribute

column_delimiter: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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 | Mapping[str, Any]]] = None)

Definition: DataSet

Attributes

name class-attribute instance-attribute

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

Dataset name

display_name class-attribute instance-attribute

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

Dataset display name

query class-attribute instance-attribute

query: Optional[List[PassThroughNativeQuery | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Pass-through Native Queries

DataSetsList dataclass

DataSetsList(*, value: Optional[List[DataSet | Mapping[str, Any]]] = None)

Definition: DataSetsList

Attributes

value class-attribute instance-attribute

value: Optional[List[DataSet | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of datasets

DataSetsMetadata dataclass

DataSetsMetadata(*, tabular: Optional[TabularDataSetsMetadata | Mapping[str, Any]] = None, blob: Optional[BlobDataSetsMetadata | Mapping[str, Any]] = None)

Definition: DataSetsMetadata

ExecuteSoqlQueryParameters dataclass

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

Definition: ExecuteSoqlQueryParameters

Attributes

query instance-attribute

query: str

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

parameters class-attribute instance-attribute

parameters: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

Name of the external ID field, used at runtime.

display_name class-attribute instance-attribute

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

Display name of the external ID field.

Item dataclass

Item(*, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Definition: Item

PassThroughNativeQuery dataclass

PassThroughNativeQuery(*, language: Optional[str] = None)

Definition: PassThroughNativeQuery

Attributes

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

Procedure name

display_name class-attribute instance-attribute

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

Procedure display name

Table dataclass

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

Definition: Table

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DynamicProperties'})

Additional table properties provided by the connector to the clients.

TableCapabilitiesMetadata dataclass

TableCapabilitiesMetadata(*, sort_restrictions: Optional[TableSortRestrictionsMetadata | Mapping[str, Any]] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata | Mapping[str, Any]] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata | Mapping[str, Any]] = 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute

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

List of supported filter capabilities

server_paging_options class-attribute instance-attribute

server_paging_options: Optional[List[str]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute

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

List of non filterable properties

required_properties class-attribute instance-attribute

required_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute

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

List of unsortable properties

ascending_only_properties class-attribute instance-attribute

ascending_only_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

Dataset source

display_name class-attribute instance-attribute

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

Dataset display name

url_encoding class-attribute instance-attribute

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

Dataset url encoding

table_display_name class-attribute instance-attribute

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

Table display name

table_plural_name class-attribute instance-attribute

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

Table plural display name

CreateJobRequest dataclass

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

Definition: CreateJobRequest

Attributes

column_delimiter class-attribute instance-attribute

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

Column Delimiter

external_id_field_name class-attribute instance-attribute

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

External ID Field Name

line_ending class-attribute instance-attribute

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

Line Ending

object instance-attribute

object: str

Object

operation instance-attribute

operation: str

Operation

InstanceUrlResponse dataclass

InstanceUrlResponse(*, instance_url: Optional[str] = None)

Definition: InstanceUrlResponse

Attributes

instance_url class-attribute instance-attribute

instance_url: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default_factory=dict, kw_only=True)

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]] = dataclass_field(default=None, kw_only=True)

Attributes of a search record

id class-attribute instance-attribute

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

Unique identifier of the record

CloseJobRequest dataclass

CloseJobRequest(state: str)

Definition: CloseJobRequest

Attributes

state instance-attribute

state: str

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, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

list_tables

list_tables(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get object types

This operation lists the available Salesforce object types.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetTables.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_item_by_external_id async

get_item_by_external_id(table: str, external_id_field: str, external_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a Record by External ID

This operation retrieves a record using an external ID.

Swagger operation ID: GetItemByExternalId.

Parameters:

Name	Type	Description	Default
table	str	The Salesforce object type like 'Leads'.	required
external_id_field	str	Field marked as external ID field on Salesforce object.	required
external_id	str	External ID of the record to retrieve.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items

list_items(table: str, *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get records

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

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems.

Parameters:

Name	Type	Description	Default
table	str	The Salesforce object type like 'Leads'.	required
filter	Optional[str]	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
skip	Optional[int]	The number of entries to skip (default = 0).	None
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items_table_account

list_items_table_account(*, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get Account records from Salesforce

This operation gets Account records from Salesforce.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems_table_account.

Parameters:

Name	Type	Description	Default
filter	Optional[str]	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
skip	Optional[int]	The number of entries to skip (default = 0).	None
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items_table_user

list_items_table_user(*, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get User records from Salesforce

This operation gets User records from Salesforce.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems_table_user.

Parameters:

Name	Type	Description	Default
filter	Optional[str]	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
skip	Optional[int]	The number of entries to skip (default = 0).	None
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items_table_case

list_items_table_case(*, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get Case records from Salesforce

This operation gets Case records from Salesforce.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems_table_case.

Parameters:

Name	Type	Description	Default
filter	Optional[str]	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
skip	Optional[int]	The number of entries to skip (default = 0).	None
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items_table_opportunity

list_items_table_opportunity(*, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get Opportunity records from Salesforce

This operation gets Opportunity records from Salesforce.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems_table_opportunity.

Parameters:

Name	Type	Description	Default
filter	Optional[str]	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
skip	Optional[int]	The number of entries to skip (default = 0).	None
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items_table_product2

list_items_table_product2(*, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get Product records from Salesforce

This operation gets Product records from Salesforce.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems_table_product2.

Parameters:

Name	Type	Description	Default
filter	Optional[str]	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
skip	Optional[int]	The number of entries to skip (default = 0).	None
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items_table_contact

list_items_table_contact(*, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get Contact records from Salesforce

This operation gets Contact records from Salesforce.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems_table_contact.

Parameters:

Name	Type	Description	Default
filter	Optional[str]	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
skip	Optional[int]	The number of entries to skip (default = 0).	None
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_item async

delete_item(table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete record

This operation deletes a record.

Swagger operation ID: DeleteItem.

Parameters:

Name	Type	Description	Default
table	str	The Salesforce object type like 'Leads'.	required
id	str	The unique identifier of record to delete.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

execute_soql_query async

execute_soql_query(input: ExecuteSoqlQueryParameters | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Execute a SOQL query

Execute a SOQL query.

Swagger operation ID: ExecuteSoqlQuery.

Parameters:

Name	Type	Description	Default
input	ExecuteSoqlQueryParameters | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_all_jobs

list_all_jobs(*, concurreny_mode: Optional[str] = None, is_pk_chunking_enabled: Optional[bool] = None, job_type: Optional[str] = None, query_locator: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get all jobs

Get a list of all jobs

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllJobs.

Parameters:

Name	Type	Description	Default
concurreny_mode	Optional[str]	Concurrency Mode.	None
is_pk_chunking_enabled	Optional[bool]	Is PK Chunking Enabled.	None
job_type	Optional[str]	Job Type.	None
query_locator	Optional[str]	Query Locator.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

upload_job_data async

upload_job_data(input: bytes, job_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Upload job data

Uploads data for a job using CSV data.

Swagger operation ID: UploadJobData.

Parameters:

Name	Type	Description	Default
input	bytes	The binary request body.	required
job_id	str	Job ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_job_info async

get_job_info(job_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get job info

Retrieves detailed information about a job.

Swagger operation ID: GetJobInfo.

Parameters:

Name	Type	Description	Default
job_id	str	Job ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

close_job async

close_job(input: CloseJobRequest | Mapping[str, Any], job_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: CloseJob.

Parameters:

Name	Type	Description	Default
input	CloseJobRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
job_id	str	Job ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_job async

delete_job(job_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a job

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

Swagger operation ID: DeleteJob.

Parameters:

Name	Type	Description	Default
job_id	str	Job ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_job_record_results async

get_job_record_results(job_id: str, result_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get job results

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

Swagger operation ID: GetJobRecordResults.

Parameters:

Name	Type	Description	Default
job_id	str	Job ID.	required
result_type	str	Result Type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

execute_sosl_query async

execute_sosl_query(q: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Execute SOSL search query

Execute the specified SOSL search qyery

Swagger operation ID: ExecuteSOSLQuery.

Parameters:

Name	Type	Description	Default
q	str	SOSL search string.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

http_request async

http_request(input: bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Send an HTTP request

Construct a Salesforce REST API request to invoke

Swagger operation ID: HttpRequest.

Parameters:

Name	Type	Description	Default
input	bytes	The binary request body.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

mcp_salesforce_management async

mcp_salesforce_management(input: MCPQueryRequest | Mapping[str, Any], *, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

MCP server for Salesforce

MCP server for Salesforce

Swagger operation ID: mcp_SalesforceManagement.

Parameters:

Name	Type	Description	Default
input	MCPQueryRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
session_id	Optional[str]	sessionId.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_job async

create_job(input: CreateJobParameters | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: CreateJobV2.

Parameters:

Name	Type	Description	Default
input	CreateJobParameters | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_item async

get_item(table: str, id: str, *, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get record

This operation gets a record.

Swagger operation ID: GetItem_V2.

Parameters:

Name	Type	Description	Default
table	str	table name.	required
id	str	item key.	required
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

patch_item async

patch_item(input: PatchItemInput | Mapping[str, Any], table: str, id: str, *, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update record

This operation updates a record and allows null values.

Swagger operation ID: PatchItem_V3.

Parameters:

Name	Type	Description	Default
input	PatchItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
table	str	table name.	required
id	str	item key.	required
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

patch_item_by_external_id async

patch_item_by_external_id(input: PatchItemByExternalIdInput | Mapping[str, Any], table: str, external_id_field: str, external_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: PatchItemByExternalIdV2.

Parameters:

Name	Type	Description	Default
input	PatchItemByExternalIdInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
table	str	The Salesforce object type like 'Leads'.	required
external_id_field	str	Field marked as external ID field on Salesforce object.	required
external_id	str	External ID of the record to upsert.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

post_item async

post_item(input: PostItemInput | Mapping[str, Any], table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create record

This operation creates a record and allows null values.

Swagger operation ID: PostItem_V2.

Parameters:

Name	Type	Description	Default
input	PostItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
table	str	table name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_external_id_fields

list_external_id_fields(table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get External ID Fields

This operation retrieves external ID fields of Salesforce object type.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetExternalIdFields.

Parameters:

Name	Type	Description	Default
table	str	The Salesforce object type like 'Leads'.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_metadata_for_get_item async

get_metadata_for_get_item(table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

GetMetadataForGetItem

Swagger operation ID: GetMetadataForGetItem.

Parameters:

Name	Type	Description	Default
table	str	table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_metadata_for_patch_item async

get_metadata_for_patch_item(table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

GetMetadataForPatchItem

Swagger operation ID: GetMetadataForPatchItem.

Parameters:

Name	Type	Description	Default
table	str	table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_metadata_for_post_item async

get_metadata_for_post_item(table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

GetMetadataForPostItem

Swagger operation ID: GetMetadataForPostItem.

Parameters:

Name	Type	Description	Default
table	str	table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_table async

get_table(table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get object metadata

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

Swagger operation ID: GetTable.

Parameters:

Name	Type	Description	Default
table	str	Salesforce object type like 'Leads'.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.