Index

_

__init__() (sf_toolkit.apimodels.ApiVersion method) (sf_toolkit.apimodels.OrgLimit method) (sf_toolkit.apimodels.UserInfo method) (sf_toolkit.auth.httpx.SalesforceAuth method) (sf_toolkit.auth.SalesforceAuth method) (sf_toolkit.client.AsyncSalesforceClient method) (sf_toolkit.client.SalesforceClient method) (sf_toolkit.data.fields.CheckboxField method) (sf_toolkit.data.fields.DateField method) (sf_toolkit.data.fields.DateTimeField method) (sf_toolkit.data.fields.Field method) (sf_toolkit.data.fields.FieldConfigurableObject method) (sf_toolkit.data.fields.IntField method) (sf_toolkit.data.fields.ListField method) (sf_toolkit.data.fields.MultiPicklistField method) (sf_toolkit.data.fields.MultiPicklistValue method) (sf_toolkit.data.fields.NumberField method) (sf_toolkit.data.fields.PicklistField method) (sf_toolkit.data.fields.TextField method) (sf_toolkit.data.fields.TimeField method) (sf_toolkit.data.query_builder.BooleanOperation method) (sf_toolkit.data.query_builder.Comparison method) (sf_toolkit.data.query_builder.NOT method) (sf_toolkit.data.query_builder.QueryResult method) (sf_toolkit.data.query_builder.QueryResultBatch method) (sf_toolkit.data.query_builder.SoqlQuery method) (sf_toolkit.data.sobject.SObject method) (sf_toolkit.data.sobject.SObjectDescribe method) (sf_toolkit.data.sobject.SObjectList method) (sf_toolkit.exceptions.SalesforceAuthenticationFailed method) (sf_toolkit.exceptions.SalesforceError method) (sf_toolkit.exceptions.SalesforceRecordNotModifiedSince method)

A

AND() (in module sf_toolkit.data.query_builder) and_having() (sf_toolkit.data.query_builder.SoqlQuery method) and_where() (sf_toolkit.data.query_builder.SoqlQuery method) api_usage (sf_toolkit.metrics.ApiUsage attribute) ApiUsage (class in sf_toolkit.metrics) ApiVersion (class in sf_toolkit.apimodels)

append() (sf_toolkit.data.sobject.SObjectList method) as_async (sf_toolkit.client.SalesforceClient property) as_list() (sf_toolkit.data.query_builder.QueryResult method) AsyncSalesforceClient (class in sf_toolkit.client) auth_flow() (sf_toolkit.auth.httpx.SalesforceAuth method) (sf_toolkit.auth.SalesforceAuth method) autoNumber (sf_toolkit.data.fields.SObjectFieldDescribe attribute)

B

batch_index (sf_toolkit.data.query_builder.QueryResult attribute) batch_size (sf_toolkit.data.query_builder.QueryResultBatch attribute) batches (sf_toolkit.data.query_builder.QueryResult attribute)

BooleanOperation (class in sf_toolkit.data.query_builder) build_conditional() (sf_toolkit.data.query_builder.SoqlQuery class method) build_conditional_clause() (sf_toolkit.data.query_builder.SoqlQuery class method)

C

calculated (sf_toolkit.data.fields.FieldFlag attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute) callback (sf_toolkit.auth.httpx.SalesforceAuth attribute) (sf_toolkit.auth.SalesforceAuth attribute) case_sensitive (sf_toolkit.data.fields.FieldFlag attribute) caseSensitive (sf_toolkit.data.fields.SObjectFieldDescribe attribute) CheckboxField (class in sf_toolkit.data.fields) cli_login() (in module sf_toolkit.auth) (in module sf_toolkit.auth.login_cli)

client_credentials_flow_login() (in module sf_toolkit.auth) comparator (sf_toolkit.data.query_builder.Comparison attribute) Comparison (class in sf_toolkit.data.query_builder) conditions (sf_toolkit.data.query_builder.BooleanOperation attribute) copy() (sf_toolkit.data.query_builder.QueryResult method) count() (sf_toolkit.data.query_builder.SoqlQuery method) createable (sf_toolkit.data.fields.FieldFlag attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute)

D

DateField (class in sf_toolkit.data.fields) DateTimeField (class in sf_toolkit.data.fields) defaultValue (sf_toolkit.data.fields.SObjectFieldDescribe attribute) delete() (sf_toolkit.data.sobject.SObject method) (sf_toolkit.data.sobject.SObjectList method) delete_async() (sf_toolkit.data.sobject.SObjectList static method) dependentPicklist (sf_toolkit.data.fields.SObjectFieldDescribe attribute)

deprecatedAndHidden (sf_toolkit.data.fields.SObjectFieldDescribe attribute) describe() (sf_toolkit.data.sobject.SObject class method) direction (sf_toolkit.data.query_builder.Order attribute) dirty_fields (sf_toolkit.data.fields.FieldConfigurableObject property) display_location_in_decimal (sf_toolkit.data.fields.FieldFlag attribute) displayLocationInDecimal (sf_toolkit.data.fields.SObjectFieldDescribe attribute) done (sf_toolkit.data.query_builder.QueryResult property) (sf_toolkit.data.query_builder.QueryResultBatch attribute), [1]

E

EQ() (in module sf_toolkit.data.query_builder) execute() (sf_toolkit.data.query_builder.SoqlQuery method)

extend() (sf_toolkit.data.sobject.SObjectList method) externalId (sf_toolkit.data.fields.SObjectFieldDescribe attribute)

F

Field (class in sf_toolkit.data.fields) field (sf_toolkit.data.query_builder.Order attribute) FieldConfigurableObject (class in sf_toolkit.data.fields) FieldFlag (class in sf_toolkit.data.fields) fields (sf_toolkit.data.query_builder.SoqlQuery property) filter_subqueries() (sf_toolkit.data.query_builder.SoqlQuery method) filterable (sf_toolkit.data.fields.FieldFlag attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute) flags (sf_toolkit.data.fields.Field attribute) format() (sf_toolkit.data.fields.DateField method) (sf_toolkit.data.fields.DateTimeField method) (sf_toolkit.data.fields.Field method) (sf_toolkit.data.fields.TimeField method) (sf_toolkit.data.query_builder.SoqlQuery method)

format_datetime() (in module sf_toolkit.formatting) format_external_id() (in module sf_toolkit.formatting) format_field() (sf_toolkit.formatting.SoqlFormatter method) format_soql() (in module sf_toolkit.formatting) from_description() (sf_toolkit.data.sobject.SObject class method) from_dict() (sf_toolkit.data.sobject.SObjectDescribe class method)

G

GE() (in module sf_toolkit.data.query_builder) get_field() (sf_toolkit.data.sobject.SObjectDescribe method) get_raw_data() (sf_toolkit.data.sobject.SObjectDescribe method)

group_by() (sf_toolkit.data.query_builder.SoqlQuery method) groupable (sf_toolkit.data.fields.FieldFlag attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute) GT() (in module sf_toolkit.data.query_builder)

H

handle_async_clone_token_refresh() (sf_toolkit.client.SalesforceClient method)

having() (sf_toolkit.data.query_builder.SoqlQuery method)

I

IdField (class in sf_toolkit.data.fields) IN() (in module sf_toolkit.data.query_builder) INCLUDES() (in module sf_toolkit.data.query_builder) instance (sf_toolkit.auth.SalesforceToken attribute) (sf_toolkit.auth.types.SalesforceToken attribute)

IntField (class in sf_toolkit.data.fields) ip_filtering_non_service_login() (in module sf_toolkit.auth) ip_filtering_org_login() (in module sf_toolkit.auth) is_critical() (sf_toolkit.apimodels.OrgLimit method)

K

keys() (sf_toolkit.data.fields.FieldConfigurableObject class method)

L

label (sf_toolkit.apimodels.ApiVersion attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute) lazy_build() (sf_toolkit.apimodels.ApiVersion class method) lazy_login() (in module sf_toolkit.auth) lazy_oauth_login() (in module sf_toolkit.auth) lazy_soap_login() (in module sf_toolkit.auth) LE() (in module sf_toolkit.data.query_builder)

length (sf_toolkit.data.fields.SObjectFieldDescribe attribute) LIKE() (in module sf_toolkit.data.query_builder) limit() (sf_toolkit.data.query_builder.SoqlQuery method) list() (sf_toolkit.data.sobject.SObject class method) ListField (class in sf_toolkit.data.fields) login (sf_toolkit.auth.httpx.SalesforceAuth attribute) (sf_toolkit.auth.SalesforceAuth attribute) LT() (in module sf_toolkit.data.query_builder)

M

message (sf_toolkit.exceptions.SalesforceApiVersionIncompatible attribute) (sf_toolkit.exceptions.SalesforceEdgeCommFailure attribute) (sf_toolkit.exceptions.SalesforceEdgeRoutingUnavailable attribute) (sf_toolkit.exceptions.SalesforceError attribute) (sf_toolkit.exceptions.SalesforceExpiredSession attribute) (sf_toolkit.exceptions.SalesforceHeaderLimitExceeded attribute) (sf_toolkit.exceptions.SalesforceInvalidHeaderPreconditions attribute) (sf_toolkit.exceptions.SalesforceMalformedRequest attribute) (sf_toolkit.exceptions.SalesforceMethodNotAllowedForResource attribute) (sf_toolkit.exceptions.SalesforceMissingConditionalHeader attribute) (sf_toolkit.exceptions.SalesforceMoreThanOneRecord attribute) (sf_toolkit.exceptions.SalesforceRefusedRequest attribute) (sf_toolkit.exceptions.SalesforceResourceRemoved attribute) (sf_toolkit.exceptions.SalesforceServerError attribute) (sf_toolkit.exceptions.SalesforceServerUnavailable attribute) (sf_toolkit.exceptions.SalesforceUnsupportedFormat attribute) (sf_toolkit.exceptions.SalesforceUriLimitExceeded attribute)

module sf_toolkit.apimodels sf_toolkit.auth sf_toolkit.auth.httpx sf_toolkit.auth.login_cli sf_toolkit.auth.types sf_toolkit.client sf_toolkit.data.fields sf_toolkit.data.query_builder sf_toolkit.data.sobject sf_toolkit.exceptions sf_toolkit.formatting sf_toolkit.metrics MultiPicklistField (class in sf_toolkit.data.fields) MultiPicklistValue (class in sf_toolkit.data.fields)

N

name (sf_toolkit.data.fields.SObjectFieldDescribe attribute) (sf_toolkit.metrics.PerAppUsage attribute) NE() (in module sf_toolkit.data.query_builder) nextRecordsUrl (sf_toolkit.data.query_builder.QueryResultBatch attribute), [1]

nillable (sf_toolkit.data.fields.FieldFlag attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute) NOT (class in sf_toolkit.data.query_builder) NOT_IN() (in module sf_toolkit.data.query_builder) NumberField (class in sf_toolkit.data.fields)

O

offset() (sf_toolkit.data.query_builder.SoqlQuery method) operator (sf_toolkit.data.query_builder.BooleanOperation attribute) OR() (in module sf_toolkit.data.query_builder) or_having() (sf_toolkit.data.query_builder.SoqlQuery method)

or_where() (sf_toolkit.data.query_builder.SoqlQuery method) Order (class in sf_toolkit.data.query_builder) order_by() (sf_toolkit.data.query_builder.SoqlQuery method) OrgLimit (class in sf_toolkit.apimodels)

P

parse_api_usage() (in module sf_toolkit.metrics) parse_datetime() (in module sf_toolkit.formatting) password_login() (in module sf_toolkit.auth) per_app_api_usage (sf_toolkit.metrics.ApiUsage attribute) PerAppUsage (class in sf_toolkit.metrics)

permissionable (sf_toolkit.data.fields.FieldFlag attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute) PicklistField (class in sf_toolkit.data.fields) picklistValues (sf_toolkit.data.fields.SObjectFieldDescribe attribute) prop (sf_toolkit.data.query_builder.Comparison attribute) public_key_auth_login() (in module sf_toolkit.auth)

Q

query() (sf_toolkit.data.sobject.SObject class method) query_fields() (sf_toolkit.data.fields.FieldConfigurableObject class method) query_locator (sf_toolkit.data.query_builder.QueryResultBatch attribute) query_more() (sf_toolkit.data.query_builder.QueryResultBatch method)

query_more_async() (sf_toolkit.data.query_builder.QueryResultBatch method) QueryResult (class in sf_toolkit.data.query_builder) QueryResultBatch (class in sf_toolkit.data.query_builder) quote_soql_value() (in module sf_toolkit.formatting)

R

raise_for_status() (in module sf_toolkit.exceptions) read() (sf_toolkit.data.sobject.SObject class method) read_async() (sf_toolkit.data.sobject.SObject class method) readonly (sf_toolkit.data.fields.FieldFlag attribute) ReadOnlyAssignmentException record_index (sf_toolkit.data.query_builder.QueryResult attribute) records (sf_toolkit.data.query_builder.QueryResultBatch attribute), [1] ReferenceField (class in sf_toolkit.data.fields) referenceTo (sf_toolkit.data.fields.SObjectFieldDescribe attribute) relationshipName (sf_toolkit.data.fields.SObjectFieldDescribe attribute) reload() (sf_toolkit.data.sobject.SObject method)

remaining() (sf_toolkit.apimodels.OrgLimit method) request() (sf_toolkit.client.AsyncSalesforceClient method) (sf_toolkit.client.SalesforceClient method) restricted_picklist (sf_toolkit.data.fields.FieldFlag attribute) restrictedPicklist (sf_toolkit.data.fields.SObjectFieldDescribe attribute) revive() (sf_toolkit.data.fields.DateField method) (sf_toolkit.data.fields.DateTimeField method) (sf_toolkit.data.fields.Field method) (sf_toolkit.data.fields.ListField method) (sf_toolkit.data.fields.MultiPicklistField method) (sf_toolkit.data.fields.ReferenceField method)

S

SalesforceApiVersionIncompatible SalesforceAuth (class in sf_toolkit.auth) (class in sf_toolkit.auth.httpx) SalesforceAuthenticationFailed SalesforceBulkV2ExtractError SalesforceBulkV2LoadError SalesforceClient (class in sf_toolkit.client) SalesforceEdgeCommFailure SalesforceEdgeRoutingUnavailable SalesforceError SalesforceExpiredSession SalesforceGeneralError SalesforceHeaderLimitExceeded SalesforceInvalidHeaderPreconditions SalesforceMalformedRequest SalesforceMethodNotAllowedForResource SalesforceMissingConditionalHeader SalesforceMoreThanOneRecord SalesforceOperationError SalesforceRecordNotModifiedSince SalesforceRefusedRequest SalesforceResourceNotFound SalesforceResourceRemoved SalesforceServerError SalesforceServerUnavailable SalesforceToken (class in sf_toolkit.auth) (class in sf_toolkit.auth.types) SalesforceUnsupportedFormat SalesforceUriLimitExceeded save() (sf_toolkit.data.sobject.SObject method) (sf_toolkit.data.sobject.SObjectList method) save_insert() (sf_toolkit.data.sobject.SObject method) (sf_toolkit.data.sobject.SObjectList method) save_insert_async() (sf_toolkit.data.sobject.SObjectList static method) save_update() (sf_toolkit.data.sobject.SObject method) (sf_toolkit.data.sobject.SObjectList method) save_update_async() (sf_toolkit.data.sobject.SObjectList static method) save_upsert() (sf_toolkit.data.sobject.SObject method) (sf_toolkit.data.sobject.SObjectList method)

save_upsert_async() (sf_toolkit.data.sobject.SObjectList static method) security_token_login() (in module sf_toolkit.auth) serialize() (sf_toolkit.data.fields.FieldConfigurableObject method) sf_toolkit.apimodels module sf_toolkit.auth module sf_toolkit.auth.httpx module sf_toolkit.auth.login_cli module sf_toolkit.auth.types module sf_toolkit.client module sf_toolkit.data.fields module sf_toolkit.data.query_builder module sf_toolkit.data.sobject module sf_toolkit.exceptions module sf_toolkit.formatting module sf_toolkit.metrics module SObject (class in sf_toolkit.data.sobject) sobject_name (sf_toolkit.data.query_builder.SoqlQuery property) sobject_type (sf_toolkit.data.query_builder.SoqlQuery attribute) SObjectDescribe (class in sf_toolkit.data.sobject) SObjectFieldDescribe (class in sf_toolkit.data.fields) SObjectList (class in sf_toolkit.data.sobject) SoqlFormatter (class in sf_toolkit.formatting) SoqlQuery (class in sf_toolkit.data.query_builder) sortable (sf_toolkit.data.fields.FieldFlag attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute)

T

TextField (class in sf_toolkit.data.fields) TimeField (class in sf_toolkit.data.fields) token (sf_toolkit.auth.httpx.SalesforceAuth attribute) (sf_toolkit.auth.SalesforceAuth attribute) (sf_toolkit.auth.SalesforceToken attribute) (sf_toolkit.auth.types.SalesforceToken attribute)

token_refresh_callback (sf_toolkit.client.SalesforceClient attribute) total (sf_toolkit.metrics.PerAppUsage attribute) (sf_toolkit.metrics.Usage attribute) total_size (sf_toolkit.data.query_builder.QueryResult attribute) totalSize (sf_toolkit.data.query_builder.QueryResultBatch attribute), [1] type (sf_toolkit.data.fields.SObjectFieldDescribe attribute)

U

unique (sf_toolkit.data.fields.FieldFlag attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute) unregister_parent() (sf_toolkit.client.AsyncSalesforceClient method) update_values() (sf_toolkit.data.sobject.SObject method) updateable (sf_toolkit.data.fields.FieldFlag attribute) (sf_toolkit.data.fields.SObjectFieldDescribe attribute)

url (sf_toolkit.apimodels.ApiVersion attribute) Usage (class in sf_toolkit.metrics) usage_percentage() (sf_toolkit.apimodels.OrgLimit method) used (sf_toolkit.metrics.PerAppUsage attribute) (sf_toolkit.metrics.Usage attribute) UserInfo (class in sf_toolkit.apimodels)

V

validate() (sf_toolkit.data.fields.Field method) (sf_toolkit.data.fields.IdField method) (sf_toolkit.data.fields.MultiPicklistField method) (sf_toolkit.data.fields.PicklistField method)

value (sf_toolkit.data.query_builder.Comparison attribute) values (sf_toolkit.data.fields.MultiPicklistValue attribute) version (sf_toolkit.apimodels.ApiVersion attribute) versions (sf_toolkit.client.SalesforceClient property) versions() (sf_toolkit.client.AsyncSalesforceClient method)

W

where() (sf_toolkit.data.query_builder.SoqlQuery method)

write_requires_master_read (sf_toolkit.data.fields.FieldFlag attribute) writeRequiresMasterRead (sf_toolkit.data.fields.SObjectFieldDescribe attribute)