doc/gen (#9)

* doc/gen Updated `src/Action.php`. * doc/gen Updated `src/Actions.php`. * doc/gen Updated `src/Collaborator.php`. * doc/gen Updated `src/CollaboratorPivot.php`. * doc/gen Updated `src/Collaborators.php`. * doc/gen Updated `src/CreateCollaborator.php`. * doc/gen Updated `src/CreateHeartbeat.php`. * doc/gen Updated `src/CreateHook.php`. * doc/gen Updated `src/CreateNotification.php`. * doc/gen Updated `src/CreateProject.php`. * doc/gen Updated `src/CreateServer.php`. * doc/gen Updated `src/DeleteCollaborator.php`. * doc/gen Updated `src/DeployProject.php`. * doc/gen Updated `src/Deployment.php`. * doc/gen Updated `src/Deployments.php`. * doc/gen Updated `src/Environment.php`. * doc/gen Updated `src/EnvironmentServers.php`. * doc/gen Updated `src/Folder.php`. * doc/gen Updated `src/GetDeployment.php`. * doc/gen Updated `src/GetEnvironment.php`. * doc/gen Updated `src/GetLinkedFolders.php`. * doc/gen Updated `src/Heartbeat.php`. * doc/gen Updated `src/Heartbeats.php`. * doc/gen Updated `src/Hook.php`. * doc/gen Updated `src/Hooks.php`. * doc/gen Updated `src/NewProject.php`. * doc/gen Updated `src/Notification.php`. * doc/gen Updated `src/NotificationOption.php`. * doc/gen Updated `src/NotificationType.php`. * doc/gen Updated `src/Notifications.php`. * doc/gen Updated `src/PhpVersion.php`. * doc/gen Updated `src/Process.php`. * doc/gen Updated `src/Project.php`. * doc/gen Updated `src/ProjectResponse.php`. * doc/gen Updated `src/ProjectType.php`. * doc/gen Updated `src/Projects.php`. * doc/gen Updated `src/Provider.php`. * doc/gen Updated `src/ResetEnvironment.php`. * doc/gen Updated `src/Server.php`. * doc/gen Updated `src/Servers.php`. * doc/gen Updated `src/UpdateEnvironment.php`. * doc/gen Updated `src/UpdateHook.php`. * doc/gen Updated `src/UpdateNotification.php`. * doc/gen Updated `src/UpdateProject.php`. * doc/gen Updated `src/UpdateProjectSource.php`. * doc/gen Updated `src/UpdateServer.php`.
zero-to-prod · Feb 18, 2025 · a90f52d · a90f52d
1 parent 050da91
commit a90f52d
Show file tree

Hide file tree

Showing 46 changed files with 1,888 additions and 436 deletions.
diff --git a/src/Action.php b/src/Action.php
@@ -2,37 +2,82 @@
 
 namespace Zerotoprod\DataModelEnvoyer;
 
+/**
+ * @link https://github.com/zero-to-prod/data-model-envoyer
+ */
 class Action
 {
     use DataModel;
 
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const id = 'id';
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const version = 'version';
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const name = 'name';
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const view = 'view';
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const sequence = 'sequence';
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const created_at = 'created_at';
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const updated_at = 'updated_at';
 
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public int $id;
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public int $version;
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public string $name;
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public string $view;
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public int $sequence;
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public string $created_at;
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public string $updated_at;
 }
diff --git a/src/Actions.php b/src/Actions.php
@@ -5,17 +5,24 @@
 use Zerotoprod\DataModel\Describe;
 use Zerotoprod\DataModelHelper\DataModelHelper;
 
+/**
+ * @link https://github.com/zero-to-prod/data-model-envoyer
+ */
 class Actions
 {
     use DataModel;
 
-    /** @link https://envoyer.io/api-documentation#list-actions */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const actions = 'actions';
 
     /**
      * @var Action[] $actions
      *
-     * @link https://envoyer.io/api-documentation#list-actions
+     * @see  https://envoyer.io/api-documentation#list-actions
+     * @link https://github.com/zero-to-prod/data-model-envoyer
      */
     #[Describe([
             'cast' => [DataModelHelper::class, 'mapOf'],

diff --git a/src/Collaborator.php b/src/Collaborator.php
@@ -2,24 +2,51 @@
 
 namespace Zerotoprod\DataModelEnvoyer;
 
+/**
+ * @link https://github.com/zero-to-prod/data-model-envoyer
+ */
 class Collaborator
 {
     use DataModel;
 
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const id = 'id';
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const name = 'name';
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const email = 'email';
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const pivot = 'pivot';
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public int $id;
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public string $name;
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public string $email;
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public CollaboratorPivot $pivot;
 }
diff --git a/src/CollaboratorPivot.php b/src/CollaboratorPivot.php
@@ -2,21 +2,42 @@
 
 namespace Zerotoprod\DataModelEnvoyer;
 
+/**
+ * @link https://github.com/zero-to-prod/data-model-envoyer
+ */
 class CollaboratorPivot
 {
     use DataModel;
 
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const project_id = 'project_id';
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const collaborator_id = 'collaborator_id';
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const status = 'status';
 
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public int $project_id;
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public int $collaborator_id;
-    /** @link https://envoyer.io/api-documentation#get-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#get-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public string $status;
 }
diff --git a/src/Collaborators.php b/src/Collaborators.php
@@ -5,17 +5,24 @@
 use Zerotoprod\DataModel\Describe;
 use Zerotoprod\DataModelHelper\DataModelHelper;
 
+/**
+ * @link https://github.com/zero-to-prod/data-model-envoyer
+ */
 class Collaborators
 {
     use DataModel;
 
-    /** @link https://envoyer.io/api-documentation#list-collaborators */
+    /**
+     * @see  https://envoyer.io/api-documentation#list-collaborators
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const collaborators = 'collaborators';
 
     /**
      * @var Collaborator[] $collaborators
      *
-     * @link https://envoyer.io/api-documentation#list-collaborators
+     * @see  https://envoyer.io/api-documentation#list-collaborators
+     * @link https://github.com/zero-to-prod/data-model-envoyer
      */
     #[Describe([
             'cast' => [DataModelHelper::class, 'mapOf'],

diff --git a/src/CreateCollaborator.php b/src/CreateCollaborator.php
@@ -2,13 +2,22 @@
 
 namespace Zerotoprod\DataModelEnvoyer;
 
+/**
+ * @link https://github.com/zero-to-prod/data-model-envoyer
+ */
 class CreateCollaborator
 {
     use DataModel;
 
-    /** @link https://envoyer.io/api-documentation#create-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#create-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const email = 'email';
 
-    /** @link https://envoyer.io/api-documentation#create-collaborator */
+    /**
+     * @see  https://envoyer.io/api-documentation#create-collaborator
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public string $actions;
 }
diff --git a/src/CreateHeartbeat.php b/src/CreateHeartbeat.php
@@ -2,11 +2,17 @@
 
 namespace Zerotoprod\DataModelEnvoyer;
 
+/**
+ * @link https://github.com/zero-to-prod/data-model-envoyer
+ */
 class CreateHeartbeat
 {
     use DataModel;
 
-    /** @link https://envoyer.io/api-documentation#create-heartbeat */
+    /**
+     * @see  https://envoyer.io/api-documentation#create-heartbeat
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public const name = 'name';
     /**
      * Intervals are minute based and can be one of the following:
@@ -18,11 +24,15 @@ class CreateHeartbeat
      * 10080 (1 Week)
      * 44640 (1 Month)
      *
-     * @link https://envoyer.io/api-documentation#create-heartbeat
+     * @see  https://envoyer.io/api-documentation#create-heartbeat
+     * @link https://github.com/zero-to-prod/data-model-envoyer
      */
     public const interval = 'interval';
 
-    /** @link https://envoyer.io/api-documentation#create-heartbeat */
+    /**
+     * @see  https://envoyer.io/api-documentation#create-heartbeat
+     * @link https://github.com/zero-to-prod/data-model-envoyer
+     */
     public string $name;
     /**
      * Intervals are minute based and can be one of the following:
@@ -34,7 +44,8 @@ class CreateHeartbeat
      * 10080 (1 Week)
      * 44640 (1 Month)
      *
-     * @link https://envoyer.io/api-documentation#create-heartbeat
+     * @see  https://envoyer.io/api-documentation#create-heartbeat
+     * @link https://github.com/zero-to-prod/data-model-envoyer
      */
     public int $interval;
 }