inriverjs's Introduction

inRiver JS

A simple wrapper for the inRiver IPMC REST API.

Installation

// npm
npm i inriverjs

// yarn
yarn add inriverjs

Usage

Create the context with an initial setup of a key and Endpoint 👇

import InRiverAPIClient from "inriverjs";

const inRiverApi = new InRiverAPIClient(
  "YOUR-API-KEY-HERE",
  "https://partnerapieuw.productmarketingcloud.com"
);

Use the API 👌

inRiverApi.Model.getCVLValue("ActivityStatus")
.then((result) => {
    console.log(result.data);
});

Examples

Display all Roles in the IPMC environment:

inRiverApi.System.Roles()
    .then((result) => {
        result.data.forEach((role) => {
            console.log(role.name);
            console.log(role.description);
        });
    }).catch((error) => {
        console.error(error);
    });

Get entity summary:

inRiverApi.Entities.GetEntitySummary(1)
    .then((result) => {
        console.log(result.data.createdBy);
        console.log(result.data.displayName);
    }).catch((error) => {
        console.error(error);
    });

Buy Me A Coffee

If you would like to support me for more inRiver Open Source tools.

inriverjs's People

Contributors

Stargazers

Watchers

inriverjs's Issues

Wrong method for /api/v1.0.0/entities/11642/fieldvalues

This is defined as POST method in Entity class, and this should be PUT method. This method is problematic:

  public SetFieldValues(entityId: number, fieldValueModels: IFieldValueModel[]): AxiosPromise<IFieldValueModel> {
    return this.request.getInstance().post(`entities/${entityId}/fieldvalues`, fieldValueModels);
  }

Recommend Projects