Module commercetools.customizedata

ballerinax/commercetools.customizedata Ballerina library

1.4.1

Overview

This is a generated connector for Commercetools API v1 OpenAPI specification.

The commercetools Platform HTTP API(Customize Data) offers an interface for programmatic access to operations related to product types,types, custom fields and custom objects.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create and configure an OAuth2 client credentials by following this guide.

Clients

commercetools.customizedata: Client

Isolated

This is a generated connector for Commercetools API v1 OpenAPI specification. The commercetools Platform HTTP API(Customize Data) offers an interface for programmatic access to operations related to product types,types, custom fields and custom objects.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create and configure an OAuth2 client credentials by following this guide.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string - URL of the target service

getProductTypeByID

Isolated FunctionRemote Function

function getProductTypeByID(string projectKey, string id, Expansion[]? expand) returns ProductType|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

ProductType|error - 200

updateProductTypeByID

Isolated FunctionRemote Function

function updateProductTypeByID(string projectKey, string id, ProductTypeUpdate payload, Expansion[]? expand) returns ProductType|error

Parameters

projectKey string -

id string -

payload ProductTypeUpdate -

expand Expansion[]? (default ()) -

Return Type

ProductType|error - 200

deleteProductTypeByID

Isolated FunctionRemote Function

function deleteProductTypeByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns ProductType|error

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

ProductType|error - 200

getProductTypeByKey

Isolated FunctionRemote Function

function getProductTypeByKey(string projectKey, string 'key, Expansion[]? expand) returns ProductType|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

ProductType|error - 200

updateProductTypeByKey

Isolated FunctionRemote Function

function updateProductTypeByKey(string projectKey, string 'key, ProductTypeUpdate payload, Expansion[]? expand) returns ProductType|error

Parameters

projectKey string -

'key string -

payload ProductTypeUpdate -

expand Expansion[]? (default ()) -

Return Type

ProductType|error - 200

deleteProductTypeByKey

Isolated FunctionRemote Function

function deleteProductTypeByKey(string projectKey, string 'key, decimal 'version, Expansion[]? expand) returns ProductType|error

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

ProductType|error - 200

queryProductTypes

Isolated FunctionRemote Function

function queryProductTypes(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ProductTypePagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

ProductTypePagedQueryResponse|error - 200

createProductTypes

Isolated FunctionRemote Function

function createProductTypes(string projectKey, ProductTypeDraft payload, Expansion[]? expand) returns ProductType|error

Parameters

projectKey string -

payload ProductTypeDraft -

expand Expansion[]? (default ()) -

Return Type

ProductType|error - 201

getTypeByID

Isolated FunctionRemote Function

function getTypeByID(string projectKey, string id, Expansion[]? expand) returns Type|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Type|error - 200

updateTypeByID

Isolated FunctionRemote Function

function updateTypeByID(string projectKey, string id, TypeUpdate payload, Expansion[]? expand) returns Type|error

Parameters

projectKey string -

id string -

payload TypeUpdate -

expand Expansion[]? (default ()) -

Return Type

Type|error - 200

deleteTypeByID

Isolated FunctionRemote Function

function deleteTypeByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns Type|error

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Type|error - 200

getTypeByKey

Isolated FunctionRemote Function

function getTypeByKey(string projectKey, string 'key, Expansion[]? expand) returns Type|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Type|error - 200

createTypeByKey

Isolated FunctionRemote Function

function createTypeByKey(string projectKey, string 'key, TypeUpdate payload, Expansion[]? expand) returns Type|error

Parameters

projectKey string -

'key string -

payload TypeUpdate -

expand Expansion[]? (default ()) -

Return Type

Type|error - 200

deleteTypeByKey

Isolated FunctionRemote Function

function deleteTypeByKey(string projectKey, string 'key, decimal 'version, Expansion[]? expand) returns Type|error

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Type|error - 200

queryTypes

Isolated FunctionRemote Function

function queryTypes(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns TypePagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

TypePagedQueryResponse|error - 200

createType

Isolated FunctionRemote Function

function createType(string projectKey, TypeDraft payload, Expansion[]? expand) returns Type|error

Parameters

projectKey string -

payload TypeDraft -

expand Expansion[]? (default ()) -

Return Type

Type|error - 201

getCustomObjectByContainerAndKey

Isolated FunctionRemote Function

function getCustomObjectByContainerAndKey(string projectKey, string container, string 'key, Expansion[]? expand) returns CustomObject|error

Get CustomObject by container and key

Parameters

projectKey string -

container string -

'key string -

expand Expansion[]? (default ()) -

Return Type

CustomObject|error - 200

deleteCustomObjectByContainerAndKey

Isolated FunctionRemote Function

function deleteCustomObjectByContainerAndKey(string projectKey, string container, string 'key, decimal? 'version, boolean? dataErasure, Expansion[]? expand) returns CustomObject|error

Delete CustomObject by container and key

Parameters

projectKey string -

container string -

'key string -

'version decimal? (default ()) -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

CustomObject|error - 200

queryCustomObject

Isolated FunctionRemote Function

function queryCustomObject(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns CustomObjectPagedQueryResponse|error

The query endpoint allows to retrieve custom objects in a specific container or all custom objects. For performance reasons, it is highly advisable to query only for custom objects in a container by using the container field in the where predicate.

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

CustomObjectPagedQueryResponse|error - 200

createOrUpdateCustomObject

Isolated FunctionRemote Function

function createOrUpdateCustomObject(string projectKey, CustomObjectDraft payload, Expansion[]? expand) returns CustomObject|error

Creates a new custom object or updates an existing custom object. If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented. If the request contains a version and an object with the given container/key exists then the version must match the version of the existing object. Concurrent updates for the same custom object still can result in a Conflict (409) even if the version is not provided. Fields with null values will not be saved.

Parameters

projectKey string -

payload CustomObjectDraft -

expand Expansion[]? (default ()) -

Return Type

CustomObject|error - 200

queryCustomObjectsByContainer

Isolated FunctionRemote Function

function queryCustomObjectsByContainer(string projectKey, string container, QueryPredicate[]? 'where, string[]? varAZaZ09, Expansion[]? expand) returns CustomObjectPagedQueryResponse|error