Module commercetools.customizebehavior

ballerinax/commercetools.customizebehavior Ballerina library

1.4.1

Overview

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

The commercetools Platform HTTP API(Pricing & Discount) offers an interface for programmatic access to to information on customize behavior.

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.customizebehavior: Client

Isolated

This is a generated connector for Commercetools API v1 OpenAPI specification. The commercetools Platform HTTP API(Customize Behavior) offers an interface for programmatic access to the data stored on the platform and associated functionality for customize behavior.

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

getExtensionByKey

Isolated FunctionRemote Function

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

Retrieves the representation of an extension by its key.

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Extension|error - 200

updateExtensionByKey

Isolated FunctionRemote Function

function updateExtensionByKey(string projectKey, string 'key, ExtensionUpdate payload, Expansion[]? expand) returns Extension|error

Parameters

projectKey string -

'key string -

payload ExtensionUpdate -

expand Expansion[]? (default ()) -

Return Type

Extension|error - 200

deleteExtensionByKey

Isolated FunctionRemote Function

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

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Extension|error - 200

getExtensionByID

Isolated FunctionRemote Function

function getExtensionByID(string projectKey, string id, Expansion[]? expand) returns Extension|error

Retrieves the representation of an extension by its id.

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Extension|error - 200

updateExtensionByID

Isolated FunctionRemote Function

function updateExtensionByID(string projectKey, string id, ExtensionUpdate payload, Expansion[]? expand) returns Extension|error

Parameters

projectKey string -

id string -

payload ExtensionUpdate -

expand Expansion[]? (default ()) -

Return Type

Extension|error - 200

deleteExtensionByID

Isolated FunctionRemote Function

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

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Extension|error - 200

queryExtensions

Isolated FunctionRemote Function

function queryExtensions(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ExtensionPagedQueryResponse|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

ExtensionPagedQueryResponse|error - 200

createExtensions

Isolated FunctionRemote Function

function createExtensions(string projectKey, ExtensionDraft payload, Expansion[]? expand) returns Extension|error

Currently, a maximum of 25 extensions can be created per project.

Parameters

projectKey string -

payload ExtensionDraft -

expand Expansion[]? (default ()) -

Return Type

Extension|error - 201

querySubscriptions

Isolated FunctionRemote Function

function querySubscriptions(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns SubscriptionPagedQueryResponse|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

SubscriptionPagedQueryResponse|error - 200

createSubscriptions

Isolated FunctionRemote Function

function createSubscriptions(string projectKey, SubscriptionDraft payload, Expansion[]? expand) returns Subscription|error

The creation of a Subscription is eventually consistent, it may take up to a minute before it becomes fully active. In order to test that the destination is correctly configured, a test message will be put into the queue. If the message could not be delivered, the subscription will not be created. The payload of the test message is a notification of type ResourceCreated for the resourceTypeId subscription. Currently, a maximum of 25 subscriptions can be created per project.

Parameters

projectKey string -

payload SubscriptionDraft -

expand Expansion[]? (default ()) -

Return Type

Subscription|error - 201

getSubscriptionByKey

Isolated FunctionRemote Function

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

Retrieves the representation of a subscription by its key.

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Subscription|error - 200

updateSubscriptionByKey

Isolated FunctionRemote Function

function updateSubscriptionByKey(string projectKey, string 'key, SubscriptionUpdate payload, Expansion[]? expand) returns Subscription|error

Parameters

projectKey string -

'key string -

payload SubscriptionUpdate -

expand Expansion[]? (default ()) -

Return Type

Subscription|error - 200

deleteSubscriptionByKey

Isolated FunctionRemote Function

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

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Subscription|error - 200

getSubscriptionByID

Isolated FunctionRemote Function

function getSubscriptionByID(string projectKey, string id, Expansion[]? expand) returns Subscription|error

Retrieves the representation of a subscription by its id.

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Subscription|error - 200

updateSubscriptionByID

Isolated FunctionRemote Function

function updateSubscriptionByID(string projectKey, string id, SubscriptionUpdate payload, Expansion[]? expand) returns Subscription|error

Parameters

projectKey string -

id string -

payload SubscriptionUpdate -

expand Expansion[]? (default ()) -

Return Type

Subscription|error - 200

deleteSubscriptionByID

Isolated FunctionRemote Function

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

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Subscription|error - 200

getMessageByID

Isolated FunctionRemote Function

function getMessageByID(string projectKey, string id, Expansion[]? expand) returns Message|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Message|error - 200

queryMessages

Isolated FunctionRemote Function

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