Index

This is an index of the following types:

The first column is the type's initial character.

A

Name Origin Description
I
 Authentication SFClient\Auth Interface Authentication
M
 authenticatedRequest() SFAPIClient Given an arbitrary request, returns a new request with the client stored authentication information attached.

B

C
 BoolResult SFClient\Result Class BoolResult

C

C
 Client SFClient Class Client
M
 createAccount() Client
M
 createActivity() Client
M
 createAsset() Client
M
 createAssetRelationship() Client
M
 createCampaign() Client
M
 createCampaignMember() Client
M
 createCase() Client
M
 createContact() Client
M
 createContentVersion() Client
M
 createContract() Client
M
 createContractContactRole() Client
M
 createDuplicateRecordItem() Client
M
 createDuplicateRecordSet() Client
M
 createEmailMessage() Client
M
 createEvent() Client
M
 createLead() Client
M
 createMacro() Client
M
 createOpportunity() Client
M
 createOpportunityLineItem() Client
M
 createOrder() Client
M
 createOrderItem() Client
M
 createPricebook2() Client
M
 createPricebookEntry() Client
M
 createQuickText() Client
M
 createScorecard() Client
M
 createScorecardAssociation() Client
M
 createScorecardMetric() Client
M
 createSignupRequest() Client
M
 createSocialPersona() Client
M
 createSocialPost() Client
M
 createTask() Client
M
 createUser() Client
M
 createUserProvisioningRequest() Client
M
 createAccount() NPSPClient
M
 createActivity() NPSPClient
M
 createAddress() NPSPClient
M
 createAffiliation() NPSPClient
M
 createAllocation() NPSPClient
M
 createAsset() NPSPClient
M
 createAssetRelationship() NPSPClient
M
 createBatch() NPSPClient
M
 createCampaign() NPSPClient
M
 createCampaignMember() NPSPClient
M
 createCase() NPSPClient
M
 createContact() NPSPClient
M
 createContentVersion() NPSPClient
M
 createContract() NPSPClient
M
 createContractContactRole() NPSPClient
M
 createDataImport() NPSPClient
M
 createDataImportBatch() NPSPClient
M
 createDuplicateRecordItem() NPSPClient
M
 createDuplicateRecordSet() NPSPClient
M
 createEmailMessage() NPSPClient
M
 createEngagementPlan() NPSPClient
M
 createEngagementPlanTask() NPSPClient
M
 createEngagementPlanTemplate() NPSPClient
M
 createError() NPSPClient
M
 createEvent() NPSPClient
M
 createGeneralAccountingUnit() NPSPClient
M
 createGrantDeadline() NPSPClient
M
 createHousehold() NPSPClient
M
 createLead() NPSPClient
M
 createLevel() NPSPClient
M
 createMacro() NPSPClient
M
 createOppPayment() NPSPClient
M
 createOpportunity() NPSPClient
M
 createOpportunityLineItem() NPSPClient
M
 createOrder() NPSPClient
M
 createOrderItem() NPSPClient
M
 createPartialSoftCredit() NPSPClient
M
 createPricebook2() NPSPClient
M
 createPricebookEntry() NPSPClient
M
 createQuickText() NPSPClient
M
 createRecurringDonation() NPSPClient
M
 createRelationship() NPSPClient
M
 createScorecard() NPSPClient
M
 createScorecardAssociation() NPSPClient
M
 createScorecardMetric() NPSPClient
M
 createSignupRequest() NPSPClient
M
 createSocialPersona() NPSPClient
M
 createSocialPost() NPSPClient
M
 createTask() NPSPClient
M
 createTriggerHandler() NPSPClient
M
 createUser() NPSPClient
M
 createUserProvisioningRequest() NPSPClient
M
 connectWith() ReconnectingSFAPIClient Constructs a new SalesForce API client with a custom Http client and the given authentication mechanism. Extended from SFAPIClient::connectWith() to include $auth in the construction of the ReconnectingSFAPIClient.
M
 connect() SFAPIClient Constructs a new SalesForce API client with a given SalesForce API endpoint and authentication mechanism.
M
 connectWith() SFAPIClient Constructs a new SalesForce API client with a custom Http client and the given authentication mechanism.
M
 create() SFAPIClient Performs a create operation for a given type.
M
 create() ScopedSFAPIClient

D

M
 deleteAccount() Client
M
 deleteActivity() Client
M
 deleteAsset() Client
M
 deleteAssetRelationship() Client
M
 deleteCampaign() Client
M
 deleteCampaignMember() Client
M
 deleteCase() Client
M
 deleteContact() Client
M
 deleteContentVersion() Client
M
 deleteContract() Client
M
 deleteContractContactRole() Client
M
 deleteDuplicateRecordItem() Client
M
 deleteDuplicateRecordSet() Client
M
 deleteEmailMessage() Client
M
 deleteEvent() Client
M
 deleteLead() Client
M
 deleteMacro() Client
M
 deleteOpportunity() Client
M
 deleteOpportunityLineItem() Client
M
 deleteOrder() Client
M
 deleteOrderItem() Client
M
 deletePricebook2() Client
M
 deletePricebookEntry() Client
M
 deleteQuickText() Client
M
 deleteScorecard() Client
M
 deleteScorecardAssociation() Client
M
 deleteScorecardMetric() Client
M
 deleteSignupRequest() Client
M
 deleteSocialPersona() Client
M
 deleteSocialPost() Client
M
 deleteTask() Client
M
 deleteUser() Client
M
 deleteUserProvisioningRequest() Client
M
 deleteAccount() NPSPClient
M
 deleteActivity() NPSPClient
M
 deleteAddress() NPSPClient
M
 deleteAffiliation() NPSPClient
M
 deleteAllocation() NPSPClient
M
 deleteAsset() NPSPClient
M
 deleteAssetRelationship() NPSPClient
M
 deleteBatch() NPSPClient
M
 deleteCampaign() NPSPClient
M
 deleteCampaignMember() NPSPClient
M
 deleteCase() NPSPClient
M
 deleteContact() NPSPClient
M
 deleteContentVersion() NPSPClient
M
 deleteContract() NPSPClient
M
 deleteContractContactRole() NPSPClient
M
 deleteDataImport() NPSPClient
M
 deleteDataImportBatch() NPSPClient
M
 deleteDuplicateRecordItem() NPSPClient
M
 deleteDuplicateRecordSet() NPSPClient
M
 deleteEmailMessage() NPSPClient
M
 deleteEngagementPlan() NPSPClient
M
 deleteEngagementPlanTask() NPSPClient
M
 deleteEngagementPlanTemplate() NPSPClient
M
 deleteError() NPSPClient
M
 deleteEvent() NPSPClient
M
 deleteGeneralAccountingUnit() NPSPClient
M
 deleteGrantDeadline() NPSPClient
M
 deleteHousehold() NPSPClient
M
 deleteLead() NPSPClient
M
 deleteLevel() NPSPClient
M
 deleteMacro() NPSPClient
M
 deleteOppPayment() NPSPClient
M
 deleteOpportunity() NPSPClient
M
 deleteOpportunityLineItem() NPSPClient
M
 deleteOrder() NPSPClient
M
 deleteOrderItem() NPSPClient
M
 deletePartialSoftCredit() NPSPClient
M
 deletePricebook2() NPSPClient
M
 deletePricebookEntry() NPSPClient
M
 deleteQuickText() NPSPClient
M
 deleteRecurringDonation() NPSPClient
M
 deleteRelationship() NPSPClient
M
 deleteScorecard() NPSPClient
M
 deleteScorecardAssociation() NPSPClient
M
 deleteScorecardMetric() NPSPClient
M
 deleteSignupRequest() NPSPClient
M
 deleteSocialPersona() NPSPClient
M
 deleteSocialPost() NPSPClient
M
 deleteTask() NPSPClient
M
 deleteTriggerHandler() NPSPClient
M
 deleteUser() NPSPClient
M
 deleteUserProvisioningRequest() NPSPClient
M
 delete() SFAPIClient Deletes a single object of a given type with the given id.
M
 delete() ScopedSFAPIClient

E

C
 Element SFClient Class Element
C
 Endpoint SFClient\Endpoint Class Endpoint
M
 err() BoolResult
M
 err() Result Constructs a failure result of some error type E. To construct a failure an exception must be supplied.
M
 err() SFCreationResult
M
 err() SFObjectResult
M
 err() SFRecordsResult

F

M
 fullSearch() Client
C
 FailedToAuthenticate SFClient\Exceptions Class FailedToAuthenticate
M
 fullQuery() SFAPIClient Performs an multiple queries against the SalesForce query endpoint to capture all results for a given query.

G

M
 getTokenRequest() Authentication
M
 getTokenFromResponse() Authentication
M
 getTokenRequest() PasswordAuth Constructs a new request for retrieving an access token form the SalesForce REsT APi using the configured credentials.
M
 getTokenFromResponse() PasswordAuth Attempts to extract an access token from a response object that resulted from running a request generated by this class. If a token is found it will be returned, otherwise null is returned.
M
 getRESTParts() Client
M
 getAccount() Client
M
 getActivity() Client
M
 getAsset() Client
M
 getAssetRelationship() Client
M
 getCampaign() Client
M
 getCampaignMember() Client
M
 getCase() Client
M
 getContact() Client
M
 getContentVersion() Client
M
 getContract() Client
M
 getContractContactRole() Client
M
 getDuplicateRecordItem() Client
M
 getDuplicateRecordSet() Client
M
 getEmailMessage() Client
M
 getEvent() Client
M
 getLead() Client
M
 getMacro() Client
M
 getOpportunity() Client
M
 getOpportunityLineItem() Client
M
 getOrder() Client
M
 getOrderItem() Client
M
 getPricebook2() Client
M
 getPricebookEntry() Client
M
 getQuickText() Client
M
 getScorecard() Client
M
 getScorecardAssociation() Client
M
 getScorecardMetric() Client
M
 getSignupRequest() Client
M
 getSocialPersona() Client
M
 getSocialPost() Client
M
 getTask() Client
M
 getUser() Client
M
 getUserProvisioningRequest() Client
M
 getUrl() Endpoint Gets the full endpoint url
M
 getAccount() NPSPClient
M
 getActivity() NPSPClient
M
 getAddress() NPSPClient
M
 getAffiliation() NPSPClient
M
 getAllocation() NPSPClient
M
 getAsset() NPSPClient
M
 getAssetRelationship() NPSPClient
M
 getBatch() NPSPClient
M
 getCampaign() NPSPClient
M
 getCampaignMember() NPSPClient
M
 getCase() NPSPClient
M
 getContact() NPSPClient
M
 getContentVersion() NPSPClient
M
 getContract() NPSPClient
M
 getContractContactRole() NPSPClient
M
 getDataImport() NPSPClient
M
 getDataImportBatch() NPSPClient
M
 getDuplicateRecordItem() NPSPClient
M
 getDuplicateRecordSet() NPSPClient
M
 getEmailMessage() NPSPClient
M
 getEngagementPlan() NPSPClient
M
 getEngagementPlanTask() NPSPClient
M
 getEngagementPlanTemplate() NPSPClient
M
 getError() NPSPClient
M
 getEvent() NPSPClient
M
 getGeneralAccountingUnit() NPSPClient
M
 getGrantDeadline() NPSPClient
M
 getHousehold() NPSPClient
M
 getLead() NPSPClient
M
 getLevel() NPSPClient
M
 getMacro() NPSPClient
M
 getOppPayment() NPSPClient
M
 getOpportunity() NPSPClient
M
 getOpportunityLineItem() NPSPClient
M
 getOrder() NPSPClient
M
 getOrderItem() NPSPClient
M
 getPartialSoftCredit() NPSPClient
M
 getPricebook2() NPSPClient
M
 getPricebookEntry() NPSPClient
M
 getQuickText() NPSPClient
M
 getRecurringDonation() NPSPClient
M
 getRelationship() NPSPClient
M
 getScorecard() NPSPClient
M
 getScorecardAssociation() NPSPClient
M
 getScorecardMetric() NPSPClient
M
 getSignupRequest() NPSPClient
M
 getSocialPersona() NPSPClient
M
 getSocialPost() NPSPClient
M
 getTask() NPSPClient
M
 getTriggerHandler() NPSPClient
M
 getUser() NPSPClient
M
 getUserProvisioningRequest() NPSPClient
M
 getErr() BoolResult
M
 getErr() Result Returns the inner error of a failure. This returns null if the result is a success.
M
 getErr() SFCreationResult
M
 getErr() SFObjectResult
M
 getErr() SFRecordsResult
M
 get() SFAPIClient Fetches a single object of a given type.
M
 getId() SFCreation
M
 getErrors() SFCreation
M
 getTotal() SFRecords Returns the total number of objects in SalesForce that this partial collection was taken from.
M
 getNextRecordsUrl() SFRecords If there are more object in SalesForce to fetch, this returns a uri to retrieve them by. If all records have been returned, this method returns null instead.
M
 getRecords() SFRecords Returns an array of SFObjects representing records returned by the SalesForce API.
M
 getRecordsRaw() SFRecords Returns the raw elements underlying this set of records. May return an array of arrays or an array of \stdClass. Use this method with caution.
M
 getScope() ScopedSFAPIClient Returns the object type scope that is applied to this client
M
 get() ScopedSFAPIClient

H

M
 hasMore() SFRecords Returns true if there are more objects in SalesForce to fetch.

I

M
 isOk() BoolResult
M
 isError() BoolResult
M
 isError() Result Returns true if the result is a failure
M
 isOk() Result Returns true if the result is a success
M
 isOk() SFCreationResult
M
 isError() SFCreationResult
M
 isOk() SFObjectResult
M
 isError() SFObjectResult
M
 isOk() SFRecordsResult
M
 isError() SFRecordsResult

N

C
 NPSPClient SFClient Class NPSPClient

O

M
 ok() BoolResult
M
 ok() Result Constructs a successful result of some type T.
M
 ok() SFCreationResult
M
 ok() SFObjectResult
M
 ok() SFRecordsResult
M
 o() SFAPIClient Helper function for constructing a SalesForce Object REST uri.

P

C
 PasswordAuth SFClient\Auth Class PasswordAuth
M
 patchAccount() Client
M
 patchActivity() Client
M
 patchAsset() Client
M
 patchAssetRelationship() Client
M
 patchCampaign() Client
M
 patchCampaignMember() Client
M
 patchCase() Client
M
 patchContact() Client
M
 patchContentVersion() Client
M
 patchContract() Client
M
 patchContractContactRole() Client
M
 patchDuplicateRecordItem() Client
M
 patchDuplicateRecordSet() Client
M
 patchEmailMessage() Client
M
 patchEvent() Client
M
 patchLead() Client
M
 patchMacro() Client
M
 patchOpportunity() Client
M
 patchOpportunityLineItem() Client
M
 patchOrder() Client
M
 patchOrderItem() Client
M
 patchPricebook2() Client
M
 patchPricebookEntry() Client
M
 patchQuickText() Client
M
 patchScorecard() Client
M
 patchScorecardAssociation() Client
M
 patchScorecardMetric() Client
M
 patchSignupRequest() Client
M
 patchSocialPersona() Client
M
 patchSocialPost() Client
M
 patchTask() Client
M
 patchUser() Client
M
 patchUserProvisioningRequest() Client
M
 patchAccount() NPSPClient
M
 patchActivity() NPSPClient
M
 patchAddress() NPSPClient
M
 patchAffiliation() NPSPClient
M
 patchAllocation() NPSPClient
M
 patchAsset() NPSPClient
M
 patchAssetRelationship() NPSPClient
M
 patchBatch() NPSPClient
M
 patchCampaign() NPSPClient
M
 patchCampaignMember() NPSPClient
M
 patchCase() NPSPClient
M
 patchContact() NPSPClient
M
 patchContentVersion() NPSPClient
M
 patchContract() NPSPClient
M
 patchContractContactRole() NPSPClient
M
 patchDataImport() NPSPClient
M
 patchDataImportBatch() NPSPClient
M
 patchDuplicateRecordItem() NPSPClient
M
 patchDuplicateRecordSet() NPSPClient
M
 patchEmailMessage() NPSPClient
M
 patchEngagementPlan() NPSPClient
M
 patchEngagementPlanTask() NPSPClient
M
 patchEngagementPlanTemplate() NPSPClient
M
 patchError() NPSPClient
M
 patchEvent() NPSPClient
M
 patchGeneralAccountingUnit() NPSPClient
M
 patchGrantDeadline() NPSPClient
M
 patchHousehold() NPSPClient
M
 patchLead() NPSPClient
M
 patchLevel() NPSPClient
M
 patchMacro() NPSPClient
M
 patchOppPayment() NPSPClient
M
 patchOpportunity() NPSPClient
M
 patchOpportunityLineItem() NPSPClient
M
 patchOrder() NPSPClient
M
 patchOrderItem() NPSPClient
M
 patchPartialSoftCredit() NPSPClient
M
 patchPricebook2() NPSPClient
M
 patchPricebookEntry() NPSPClient
M
 patchQuickText() NPSPClient
M
 patchRecurringDonation() NPSPClient
M
 patchRelationship() NPSPClient
M
 patchScorecard() NPSPClient
M
 patchScorecardAssociation() NPSPClient
M
 patchScorecardMetric() NPSPClient
M
 patchSignupRequest() NPSPClient
M
 patchSocialPersona() NPSPClient
M
 patchSocialPost() NPSPClient
M
 patchTask() NPSPClient
M
 patchTriggerHandler() NPSPClient
M
 patchUser() NPSPClient
M
 patchUserProvisioningRequest() NPSPClient
M
 patch() SFAPIClient Updates a single object of a given type with the given id.
M
 patch() ScopedSFAPIClient

Q

M
 query() SFAPIClient Performs an arbitrary query against the SalesForce query endpoint and returns the results.

R

C
 Result SFClient\Result Class Result
C
 ReconnectingSFAPIClient SFClient\SalesForce Class ReconnectingSFAPIClient
M
 run() ReconnectingSFAPIClient Executes an arbitrary request against the SalesForce API. Extended from SFAPICLient to attempt reauthorization if the request fails due to a 401 error
M
 run() SFAPIClient Executes an arbitrary request against the SalesForce API

S

M
 search() Client
C
 SFCreationResult SFClient\Result Class SFCreationResult
C
 SFObjectResult SFClient\Result Class SFObjectResult
C
 SFRecordsResult SFClient\Result Class SFRecordsResult
C
 SFAPIClient SFClient\SalesForce Class SFAPIClient
M
 scope() SFAPIClient Constructs a new SalesForce API client that is scoped to a specific object type.
C
 SFCreation SFClient\SalesForce Class SFCreation
C
 SFObject SFClient\SalesForce Class SFObject
C
 SFRecords SFClient\SalesForce Class SFRecords
C
 ScopedSFAPIClient SFClient\SalesForce Class ScopedSFAPIClient

V

M
 value() BoolResult
M
 valueOr() BoolResult
M
 value() Result Attempts to extract and return the success value.
M
 valueOr() Result Returns the success value if the result was a success. If the result was a failure, then instead of throwing the inner error the fallback value is returned.
M
 value() SFCreationResult
M
 valueOr() SFCreationResult
M
 value() SFObjectResult
M
 valueOr() SFObjectResult
M
 value() SFRecordsResult
M
 valueOr() SFRecordsResult

W

M
 wasSuccessful() SFCreation

_

P
 $PasswordAuth PasswordAuth
P
 $PasswordAuth PasswordAuth
P
 $PasswordAuth PasswordAuth
P
 $PasswordAuth PasswordAuth
M
 __construct() PasswordAuth PasswordAuth constructor.
P
 $Client Client
P
 $Client Client
P
 $Client Client
M
 __construct() Client Client constructor.
M
 __call() Client
P
 $Element Element
M
 __construct() Element Element constructor.
M
 __isset() Element
M
 __get() Element
M
 _wrap() Element
P
 $Endpoint Endpoint
P
 $Endpoint Endpoint
M
 __construct() Endpoint Endpoint constructor.
M
 __construct() NPSPClient NPSPClient constructor.
P
 $BoolResult BoolResult
M
 __construct() BoolResult Bool constructor.
P
 $Result Result
P
 $Result Result
P
 $SFCreationResult SFCreationResult
M
 __construct() SFCreationResult SFCreation constructor.
P
 $SFObjectResult SFObjectResult
M
 __construct() SFObjectResult SFObject constructor.
P
 $SFRecordsResult SFRecordsResult
M
 __construct() SFRecordsResult SFRecords constructor.
M
 __construct() ReconnectingSFAPIClient ReconnectingSFClient constructor.
P
 $SFAPIClient SFAPIClient
P
 $SFAPIClient SFAPIClient
M
 __construct() SFAPIClient SFClient constructor.
M
 _send() SFAPIClient
P
 $SFCreation SFCreation
P
 $SFCreation SFCreation
P
 $SFCreation SFCreation
M
 __construct() SFCreation SFCreation constructor.
P
 $SFRecords SFRecords
P
 $SFRecords SFRecords
P
 $SFRecords SFRecords
P
 $SFRecords SFRecords
M
 __construct() SFRecords SFRecords constructor.
P
 $ScopedSFAPIClient ScopedSFAPIClient
P
 $ScopedSFAPIClient ScopedSFAPIClient
M
 __construct() ScopedSFAPIClient Creates a SalesForce API client scoped to a particular object type.