scolmore/inriver-laravel

A Laravel package for interacting with the inRiver PIM API

0.0.4 2024-05-22 14:19 UTC

Requires

• php: ^8.2
• guzzlehttp/guzzle: ^7.8
• illuminate/http: ^10.41|~11
• illuminate/support: ~10|~11

Requires (Dev)

• laravel/pint: ^1.13
• orchestra/testbench: ^8.21
• pestphp/pest: ^2.32

MIT

• Samuel Loft

• laravel
• InRiver

README

InRiver

InRiver Laravel is a package that allows you to easily integrate with the inRiver PIM API.

Usage

Out of the box we have all the endpoints available to you as they are on the documentation.

For example, to get channel id's for an entity id, the documentation shows the following:

https://apieuw.productmarketingcloud.com/swagger/index.html#/Channel/GetChannelsForEntityId

]

To use this in the package, you would do the following:

$channels = InRiver()->channels->getChannelsForEntityId('Product');

// As per the documentation, you can also pass the other parameters.
$channels = InRiver()->channels->getChannelsForEntityId(
    forEntityId: 'Product', 
    includeChannels: true,
    includePublications: true
);

So the URL endpoint is channels and the function from the URL is GetChannelsForEntityId, so that is the function you call.

As well as this, we also provide some other methods for your convenience. These can be found below.

Examples

• Entity
• Links
• Models/Categories
• Models/Cvls
• Models/EntityTypes
• Models/FieldSets
• Models/Languages
• Models/RestrictedFields
• Models/SpecificationTemplates

Installation

Via Composer

composer require scolmore/inriver-laravel

Change log

Please see the changelog for more information on what has changed recently.

Testing

composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Samuel Loft
• All Contributors

License

MIT. Please see the license file for more information.