commercetools

Documentation

Index

• Constants
• func AddressFieldSchema() *schema.Schema
• func CreateAddressFieldDraft(d *schema.ResourceData) *platform.BaseAddress
• func CreateAddressFieldDraftRaw(data map[string]any) *platform.BaseAddress
• func CreateCustomFieldDraft(ctx context.Context, client *platform.ByProjectKeyRequestBuilder, ...) (*platform.CustomFieldsDraft, error)
• func CreateCustomFieldDraftRaw(data map[string]any, t *platform.Type) (*platform.CustomFieldsDraft, error)
• func CreateTypeFetcher(client *platform.ByProjectKeyRequestBuilder) func(ctx context.Context, id string) (*platform.Type, error)
• func CustomFieldEncodeType(t *platform.Type, name string, value any) (any, error)
• func CustomFieldEncodeValue(t platform.FieldType, name string, value any) (any, error)
• func CustomFieldSchema() *schema.Schema
• func CustomFieldUpdateActions[T SetCustomTypeAction, F SetCustomFieldAction](ctx context.Context, client *platform.ByProjectKeyRequestBuilder, ...) ([]any, error)
• func DiffSlices(old, new map[string]any) map[string]any
• func GetTypeResource(ctx context.Context, ...) (*platform.Type, error)
• func New(version string) func() *schema.Provider
• func ValidateCurrencyCode(val any, key string) (warns []string, errs []error)
• type SetCustomFieldAction
• type SetCustomTypeAction

Constants

const TypeLocalizedString = schema.TypeMap

TypeLocalizedString defined merely for documentation, it basically is just a normal TypeMap but clarifies in the code that it should be used to store a LocalizedString

Functions

func AddressFieldSchema

func AddressFieldSchema() *schema.Schema

func CreateAddressFieldDraft

func CreateAddressFieldDraft(d *schema.ResourceData) *platform.BaseAddress

func CreateAddressFieldDraftRaw

func CreateAddressFieldDraftRaw(data map[string]any) *platform.BaseAddress

func CreateCustomFieldDraft

func CreateCustomFieldDraft(ctx context.Context, client *platform.ByProjectKeyRequestBuilder, d *schema.ResourceData) (*platform.CustomFieldsDraft, error)

func CreateCustomFieldDraftRaw

func CreateCustomFieldDraftRaw(data map[string]any, t *platform.Type) (*platform.CustomFieldsDraft, error)

func CreateTypeFetcher

func CreateTypeFetcher(client *platform.ByProjectKeyRequestBuilder) func(ctx context.Context, id string) (*platform.Type, error)

func CustomFieldEncodeType

func CustomFieldEncodeType(t *platform.Type, name string, value any) (any, error)

func CustomFieldEncodeValue

func CustomFieldEncodeValue(t platform.FieldType, name string, value any) (any, error)

func CustomFieldSchema

func CustomFieldSchema() *schema.Schema

func CustomFieldUpdateActions

func CustomFieldUpdateActions[T SetCustomTypeAction, F SetCustomFieldAction](ctx context.Context, client *platform.ByProjectKeyRequestBuilder, d *schema.ResourceData) ([]any, error)

func DiffSlices

func DiffSlices(old, new map[string]any) map[string]any

DiffSlices does a diff on two slices and returns the changes. If a field is no longer available then nil is returned.

func GetTypeResource

func GetTypeResource(ctx context.Context, getTypeByIdFunc func(ctx context.Context, id string) (*platform.Type, error), typeId string) (*platform.Type, error)

GetTypeResource returns the platform.Type for the type_id in the custom field. The type_id is cached to minimize API calls when multiple resource use the same type

func New

func New(version string) func() *schema.Provider

New returns a new terraform.ResourceProvider.

func ValidateCurrencyCode

func ValidateCurrencyCode(val any, key string) (warns []string, errs []error)

ValidateCurrencyCode checks if a currency string is valid according to https://en.wikipedia.org/wiki/ISO_4217

Types

type SetCustomFieldAction

type SetCustomFieldAction interface {
	platform.ChannelSetCustomFieldAction |
		platform.StoreSetCustomFieldAction |
		platform.CategorySetCustomFieldAction |
		platform.ShippingMethodSetCustomFieldAction |
		platform.CustomerGroupSetCustomFieldAction |
		platform.DiscountCodeSetCustomFieldAction |
		platform.CartDiscountSetCustomFieldAction |
		platform.AssociateRoleSetCustomFieldAction |
		platform.ProductSelectionSetCustomFieldAction |
		platform.BusinessUnitSetCustomFieldAction
}

type SetCustomTypeAction

type SetCustomTypeAction interface {
	platform.ChannelSetCustomTypeAction |
		platform.StoreSetCustomTypeAction |
		platform.CategorySetCustomTypeAction |
		platform.ShippingMethodSetCustomTypeAction |
		platform.CustomerGroupSetCustomTypeAction |
		platform.DiscountCodeSetCustomTypeAction |
		platform.CartDiscountSetCustomTypeAction |
		platform.AssociateRoleSetCustomTypeAction |
		platform.ProductSelectionSetCustomTypeAction |
		platform.BusinessUnitSetCustomTypeAction
}