zero-to-prod/data-model-envoyer

DataModels for the Envoyer API.

v81.0.12 2025-01-16 10:13 UTC

Requires

• php: >=8.1.0
• zero-to-prod/data-model: ^81.3
• zero-to-prod/data-model-helper: ^81.0
• zero-to-prod/package-helper: ^1.0.3
• zero-to-prod/transformable: ^71.0

Requires (Dev)

• phpunit/phpunit: ^10.0

Suggests

• juststeveking/laravel-envoyer-sdk: A simple to use PHP class to work with the Laravel Envoyer API
• zero-to-prod/data-model: Transform data into a class.

MIT

• David Smith

• envoyer
• zero-to-prod
• DataModelEnvoyer
• data-model-envoyer

README

Contents

• Introduction
• Installation
• DataModels
• Publishing DataModels
• Local Development
• Contributing

Introduction

This package offers typed classes for Envoyer API request and response objects.

Installation

You can install this package via composer:

composer require zero-to-prod/data-model-envoyer

DataModels

• ProjectResponse \Zerotoprod\DataModelEnvoyer\ProjectResponse::from();
• Project \Zerotoprod\DataModelEnvoyer\Project::from();
• CreateProject \Zerotoprod\DataModelEnvoyer\CreateProject::from();
• UpdateProject \Zerotoprod\DataModelEnvoyer\UpdateProject::from();
• UpdateProjectSource \Zerotoprod\DataModelEnvoyer\UpdateProjectSource::from();
• GetLinkedFolders \Zerotoprod\DataModelEnvoyer\GetLinkedFolders::from();
• Folder \Zerotoprod\DataModelEnvoyer\Folder::from();
• Servers \Zerotoprod\DataModelEnvoyer\Servers::from();
• Server \Zerotoprod\DataModelEnvoyer\Server::from();
• CreateServer \Zerotoprod\DataModelEnvoyer\CreateServer::from();
• UpdateServer \Zerotoprod\DataModelEnvoyer\UpdateServer::from();
• GetEnvironment \Zerotoprod\DataModelEnvoyer\GetEnvironment::from();
• Environment \Zerotoprod\DataModelEnvoyer\Environment::from();
• EnvironmentServers \Zerotoprod\DataModelEnvoyer\EnvironmentServers::from();
• UpdateEnvironment \Zerotoprod\DataModelEnvoyer\UpdateEnvironment::from();
• ResetEnvironment \Zerotoprod\DataModelEnvoyer\ResetEnvironment::from();
• Actions \Zerotoprod\DataModelEnvoyer\Actions::from();
• Action \Zerotoprod\DataModelEnvoyer\Action::from();
• Hooks \Zerotoprod\DataModelEnvoyer\Hooks::from();
• Hook \Zerotoprod\DataModelEnvoyer\Hook::from();
• CreateHook \Zerotoprod\DataModelEnvoyer\CreateHook::from();
• UpdateHook \Zerotoprod\DataModelEnvoyer\UpdateHook::from();
• Deployments \Zerotoprod\DataModelEnvoyer\Deployments::from();
• Deployment \Zerotoprod\DataModelEnvoyer\Deployment::from();
• DeployProject \Zerotoprod\DataModelEnvoyer\DeployProject::from();
• HeartBeats \Zerotoprod\DataModelEnvoyer\HeartBeats::from();
• HeartBeat \Zerotoprod\DataModelEnvoyer\HeartBeat::from();
• CreateHeartBeat \Zerotoprod\DataModelEnvoyer\CreateHeartBeat::from();
• Collaborators \Zerotoprod\DataModelEnvoyer\Collaborators::from();
• Collaborator \Zerotoprod\DataModelEnvoyer\Collaborator::from();
• CreateCollaborator \Zerotoprod\DataModelEnvoyer\CreateCollaborator::from();
• DeleteCollaborator \Zerotoprod\DataModelEnvoyer\DeleteCollaborator::from();
• Notifications \Zerotoprod\DataModelEnvoyer\Notifications::from();
• Notification \Zerotoprod\DataModelEnvoyer\Notification::from();
• CreateNotification \Zerotoprod\DataModelEnvoyer\CreateNotification::from();
• UpdateNotification \Zerotoprod\DataModelEnvoyer\UpdateNotification::from();

Publishing DataModels

You can directly import these files into your project like this:

./vendor/bin/data-model-envoyer app/DataModelEnvoyer

The first argument is the destination of where the files are copied to.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.