addresses

package
v1.23.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 23, 2021 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddressListingDataProvider added in v1.15.0

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

func NewAddressListingDataProvider added in v1.15.0

func NewAddressListingDataProvider(erplyClient Manager) *AddressListingDataProvider

func (*AddressListingDataProvider) Count added in v1.15.0

func (l *AddressListingDataProvider) Count(ctx context.Context, filters map[string]interface{}) (int, error)

func (*AddressListingDataProvider) Read added in v1.15.0

func (l *AddressListingDataProvider) Read(ctx context.Context, bulkFilters []map[string]interface{}, callback func(item interface{})) error

type Client

type Client struct {
	*common.Client
}

func NewClient

func NewClient(client *common.Client) *Client

func (*Client) DeleteAddress added in v1.14.0

func (cli *Client) DeleteAddress(ctx context.Context, filters map[string]string) error

func (*Client) DeleteAddressBulk added in v1.14.0

func (cli *Client) DeleteAddressBulk(
	ctx context.Context,
	bulkRequest []map[string]interface{},
	baseFilters map[string]string,
) (DeleteAddressResponseBulk, error)

func (*Client) GetAddressTypes added in v1.19.0

func (cli *Client) GetAddressTypes(ctx context.Context, filters map[string]string) (addrTypes []Type, err error)

func (*Client) GetAddresses

func (cli *Client) GetAddresses(ctx context.Context, filters map[string]string) (addrs []sharedCommon.Address, err error)

func (*Client) GetAddressesBulk added in v1.4.0

func (cli *Client) GetAddressesBulk(ctx context.Context, bulkFilters []map[string]interface{}, baseFilters map[string]string) (GetAddressesResponseBulk, error)

GetAddressesBulk will list addresses according to specified filters sending a bulk request to fetch more addresses than the default limit

func (*Client) SaveAddress

func (cli *Client) SaveAddress(ctx context.Context, filters map[string]string) ([]sharedCommon.Address, error)

func (*Client) SaveAddressesBulk added in v1.4.0

func (cli *Client) SaveAddressesBulk(ctx context.Context, addrMap []map[string]interface{}, attrs map[string]string) (SaveAddressesResponseBulk, error)

type DeleteAddressBulkItem added in v1.14.0

type DeleteAddressBulkItem struct {
	Status sharedCommon.StatusBulk `json:"status"`
}

type DeleteAddressResponse added in v1.14.0

type DeleteAddressResponse struct {
	Status sharedCommon.Status `json:"status"`
}

type DeleteAddressResponseBulk added in v1.14.0

type DeleteAddressResponseBulk struct {
	Status    sharedCommon.Status     `json:"status"`
	BulkItems []DeleteAddressBulkItem `json:"requests"`
}

type GetAddressesResponseBulk added in v1.4.0

type GetAddressesResponseBulk struct {
	Status    sharedCommon.Status            `json:"status"`
	BulkItems []GetAddressesResponseBulkItem `json:"requests"`
}

type GetAddressesResponseBulkItem added in v1.4.0

type GetAddressesResponseBulkItem struct {
	Status    sharedCommon.StatusBulk `json:"status"`
	Addresses sharedCommon.Addresses  `json:"records"`
}

type Manager

type Manager interface {
	GetAddresses(ctx context.Context, filters map[string]string) ([]sharedCommon.Address, error)
	GetAddressesBulk(ctx context.Context, bulkFilters []map[string]interface{}, baseFilters map[string]string) (GetAddressesResponseBulk, error)
	GetAddressTypes(ctx context.Context, filters map[string]string) ([]Type, error)
	SaveAddress(ctx context.Context, filters map[string]string) ([]sharedCommon.Address, error)
	SaveAddressesBulk(ctx context.Context, addrMap []map[string]interface{}, attrs map[string]string) (SaveAddressesResponseBulk, error)
	DeleteAddress(ctx context.Context, filters map[string]string) error
	DeleteAddressBulk(ctx context.Context, bulkRequest []map[string]interface{}, baseFilters map[string]string) (DeleteAddressResponseBulk, error)
}

type Response

type Response struct {
	Status    sharedCommon.Status    `json:"status"`
	Addresses sharedCommon.Addresses `json:"records"`
}

GetAddressesResponse ..

func (Response) GetStatus added in v1.15.0

func (r Response) GetStatus() *sharedCommon.Status

type SaveAddressResp added in v1.4.0

type SaveAddressResp struct {
	AddressID int `json:"addressID"`
}

type SaveAddressesResponseBulk added in v1.4.0

type SaveAddressesResponseBulk struct {
	Status    sharedCommon.Status             `json:"status"`
	BulkItems []SaveAddressesResponseBulkItem `json:"requests"`
}

type SaveAddressesResponseBulkItem added in v1.4.0

type SaveAddressesResponseBulkItem struct {
	Status  sharedCommon.StatusBulk `json:"status"`
	Records []SaveAddressResp       `json:"records"`
}

type Type added in v1.19.0

type Type struct {
	ID           string `json:"id"`
	Name         string `json:"name"`
	Added        string `json:"added"`
	LastModified string `json:"lastModified"`
}

type TypeResponse added in v1.19.0

type TypeResponse struct {
	Status       sharedCommon.Status `json:"status"`
	AddressTypes []Type              `json:"records"`
}

func (TypeResponse) GetStatus added in v1.19.0

func (r TypeResponse) GetStatus() *sharedCommon.Status

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL