README

Introduction
Installation
Documentation Publishing
- Automatic Documentation Publishing
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

Documentation Publishing

You can publish this README to your local documentation directory.

This can be useful for providing documentation for AI agents.

This can be done using the included script:

# Publish to default location (./docs/zero-to-prod/data-model-envoyer)
vendor/bin/zero-to-prod-data-model-envoyer

# Publish to custom directory
vendor/bin/zero-to-prod-data-model-envoyer /path/to/your/docs

Automatic Documentation Publishing

You can automatically publish documentation by adding the following to your composer.json:

{
    "scripts": {
        "post-install-cmd": [
            "zero-to-prod-data-model-envoyer"
        ],
        "post-update-cmd": [
            "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.

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

zero-to-prod / data-model-envoyer

Maintainers

Details