salesforce

README

OAuth 2.0 for Salesforce

You can verify your credentials with the following:

$ curl https://login.salesforce.com/services/oauth2/token -d "grant_type=password" -d "client_id=myClientID" -d "client_secret=myClientSecret" -d "username=myUsername" -d "password=myPasswordMySecretToken"

Deleting Dummy Data

Here is information on deleting existing dummy data:

• https://help.salesforce.com/articleView?id=000005234&type=1
• https://developer.salesforce.com/forums/?id=906F0000000g1shIAA

Documentation

Index

• Constants
• Variables
• func NewClientPassword(oc goauth.CredentialsOAuth2) (*http.Client, error)
• func NewClientPasswordSalesforceEnv() (*http.Client, error)
• type OAuth2Credentials
• type SalesforceClient
  • func NewSalesforceClient(client *http.Client, instanceName string) SalesforceClient
  • func NewSalesforceClientEnv() (SalesforceClient, error)
  • func NewSalesforceClientPassword(soc OAuth2Credentials) (SalesforceClient, error)
  • func (sc *SalesforceClient) CreateContact(contact any) (*http.Response, error)
  • func (sc *SalesforceClient) CreateSobject(sobjectName string, sobject any) (*http.Response, error)
  • func (sc *SalesforceClient) DeleteAccount(id string) (*http.Response, error)
  • func (sc *SalesforceClient) DeleteAccountsAll() error
  • func (sc *SalesforceClient) DeleteContact(id string) (*http.Response, error)
  • func (sc *SalesforceClient) DeleteContactsAll() error
  • func (sc *SalesforceClient) ExecSOQL(soql string) (*http.Response, error)
  • func (sc *SalesforceClient) GetAccountsAll() (sobjects.AccountSet, error)
  • func (sc *SalesforceClient) GetContactsAll() (sobjects.ContactSet, error)
  • func (sc *SalesforceClient) GetServicesData() (*http.Response, error)
  • func (sc *SalesforceClient) UserInfo() (User, error)
• type URLBuilder
  • func NewURLBuilder(instanceName string) URLBuilder
  • func (b *URLBuilder) Build(path string) url.URL
  • func (b *URLBuilder) BuildSobjectURL(parts ...string) url.URL
• type User

Constants

const (
	AuthzURL        = endpoints.SalesforceAuthzURL
	TokenURL        = endpoints.SalesforceTokenURL // #nosec G101
	RevokeURL       = endpoints.SalesforceRevokeURL
	ServerURLFormat = "https://%v.salesforce.com"
	HostFormat      = "%v.salesforce.com"
	TestServerURL   = "https://test.salesforce.com"
)

Variables

var Endpoint = oauth2.Endpoint{
	AuthURL:  AuthzURL,
	TokenURL: TokenURL}

Functions

func NewClientPassword

func NewClientPassword(oc goauth.CredentialsOAuth2) (*http.Client, error)

func NewClientPasswordSalesforceEnv

func NewClientPasswordSalesforceEnv() (*http.Client, error)

Types

type OAuth2Credentials

type OAuth2Credentials struct {
	goauth.CredentialsOAuth2
	InstanceName string
}

type SalesforceClient

type SalesforceClient struct {
	ClientMore httputilmore.ClientMore
	URLBuilder URLBuilder
}

func NewSalesforceClient

func NewSalesforceClient(client *http.Client, instanceName string) SalesforceClient

func NewSalesforceClientEnv

func NewSalesforceClientEnv() (SalesforceClient, error)

func NewSalesforceClientPassword

func NewSalesforceClientPassword(soc OAuth2Credentials) (SalesforceClient, error)

func (*SalesforceClient) CreateContact

func (sc *SalesforceClient) CreateContact(contact any) (*http.Response, error)

func (*SalesforceClient) CreateSobject

func (sc *SalesforceClient) CreateSobject(sobjectName string, sobject any) (*http.Response, error)

func (*SalesforceClient) DeleteAccount

func (sc *SalesforceClient) DeleteAccount(id string) (*http.Response, error)

func (*SalesforceClient) DeleteAccountsAll

func (sc *SalesforceClient) DeleteAccountsAll() error

func (*SalesforceClient) DeleteContact

func (sc *SalesforceClient) DeleteContact(id string) (*http.Response, error)

func (*SalesforceClient) DeleteContactsAll

func (sc *SalesforceClient) DeleteContactsAll() error

func (*SalesforceClient) ExecSOQL

func (sc *SalesforceClient) ExecSOQL(soql string) (*http.Response, error)

func (*SalesforceClient) GetAccountsAll

func (sc *SalesforceClient) GetAccountsAll() (sobjects.AccountSet, error)

func (*SalesforceClient) GetContactsAll

func (sc *SalesforceClient) GetContactsAll() (sobjects.ContactSet, error)

func (*SalesforceClient) GetServicesData

func (sc *SalesforceClient) GetServicesData() (*http.Response, error)

func (*SalesforceClient) UserInfo

func (sc *SalesforceClient) UserInfo() (User, error)

type URLBuilder

type URLBuilder struct {
	BaseURL url.URL
	Version string
}

func NewURLBuilder

func NewURLBuilder(instanceName string) URLBuilder

func (*URLBuilder) Build

func (b *URLBuilder) Build(path string) url.URL

func (*URLBuilder) BuildSobjectURL

func (b *URLBuilder) BuildSobjectURL(parts ...string) url.URL

type User

type User struct {
	UserID         string `json:"user_id,omitempty"`
	OrganizationID string `json:"organization_id,omitempty"`
}