Back to godoc.org

Package composite

v2.0.1+incompatible
Latest Go to latest

The latest major version is .

Published: Oct 1, 2019 | License: MIT | Module: github.com/g8rswimmer/go-sfdc

Index

type Resource

type Resource struct {
	// contains filtered or unexported fields
}

Resource is the structure that can be just to call composite APIs.

func NewResource

func NewResource(session session.ServiceFormatter) (*Resource, error)

NewResource creates a new resourse with the session. If the session is nil an error will be returned.

func (*Resource) Retrieve

func (r *Resource) Retrieve(allOrNone bool, requesters []Subrequester) (Value, error)

Retrieve will retrieve the responses to a composite requests.

type Subrequester

type Subrequester interface {
	URL() string
	ReferenceID() string
	Method() string
	HTTPHeaders() http.Header
	Body() map[string]interface{}
}

Subrequester provides the composite API requests. The order of the array is the order in which the subrequests are placed in the composite body.

type Subvalue

type Subvalue struct {
	Body           interface{}       `json:"body"`
	HTTPHeaders    map[string]string `json:"httpHeaders"`
	HTTPStatusCode int               `json:"httpStatusCode"`
	ReferenceID    string            `json:"referenceId"`
}

Subvalue is the subresponses to the composite API. Using the referende id, one will be able to match the response with the request.

type Value

type Value struct {
	Response []Subvalue `json:"compositeResponse"`
}

Value is the returned structure from the composite API response.

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier