Custom Properties (custom_property and custom_property_values events) (#500)

* add test custom_property payloads

* add test custom_property_values payload

* custom_property custom_property_values app events

* organization_custom_properties repository_custom_properties app permissions

* add custom_properties to Repository

* fix bug in (released) custom_property_values event

* correct objects for custom_property_values events

* correct objects for custom_property events

* docs say values_editable_by can be null

Author: colbylwilliams

src/Octokit.Webhooks/Events/CustomProperty/CustomPropertyCreatedEvent.cs

@@ -1,5 +1,3 @@
-using Octokit.Webhooks.Models.CustomProperty;
-
 namespace Octokit.Webhooks.Events.CustomProperty;
 
 [PublicAPI]
@@ -9,19 +7,6 @@ public sealed record CustomPropertyCreatedEvent : CustomPropertyEvent
     [JsonPropertyName("action")]
     public override string Action => CustomPropertyAction.Created;
 
-    [JsonPropertyName("value_type")]
-    [JsonConverter(typeof(StringEnumConverter<CustomPropertyValueType>))]
-    public StringEnum<CustomPropertyValueType> ValueType { get; init; } = null!;
-
-    [JsonPropertyName("default_value")]
-    public string? DefaultValue { get; init; }
-
-    [JsonPropertyName("required")]
-    public bool Required { get; init; }
-
-    [JsonPropertyName("description")]
-    public string? Description { get; init; }
-
-    [JsonPropertyName("allowed_values")]
-    public IEnumerable<string>? AllowedValues { get; init; }
+    [JsonPropertyName("definition")]
+    public Models.CustomPropertyEvent.CustomProperty CustomProperty { get; init; } = null!;
 }

src/Octokit.Webhooks/Events/CustomProperty/CustomPropertyDeletedEvent.cs

@@ -6,4 +6,7 @@ public sealed record CustomPropertyDeletedEvent : CustomPropertyEvent
 {
     [JsonPropertyName("action")]
     public override string Action => CustomPropertyAction.Deleted;
+
+    [JsonPropertyName("definition")]
+    public Models.CustomPropertyEvent.CustomPropertyLite CustomProperty { get; init; } = null!;
 }

src/Octokit.Webhooks/Events/CustomProperty/CustomPropertyUpdatedEvent.cs

@@ -1,5 +1,3 @@
-using Octokit.Webhooks.Models.CustomProperty;
-
 namespace Octokit.Webhooks.Events.CustomProperty;
 
 [PublicAPI]
@@ -9,19 +7,6 @@ public sealed record CustomPropertyUpdatedEvent : CustomPropertyEvent
     [JsonPropertyName("action")]
     public override string Action => CustomPropertyAction.Updated;
 
-    [JsonPropertyName("value_type")]
-    [JsonConverter(typeof(StringEnumConverter<CustomPropertyValueType>))]
-    public StringEnum<CustomPropertyValueType> ValueType { get; init; } = null!;
-
-    [JsonPropertyName("default_value")]
-    public string? DefaultValue { get; init; }
-
-    [JsonPropertyName("required")]
-    public bool Required { get; init; }
-
-    [JsonPropertyName("description")]
-    public string? Description { get; init; }
-
-    [JsonPropertyName("allowed_values")]
-    public IEnumerable<string>? AllowedValues { get; init; }
+    [JsonPropertyName("definition")]
+    public Models.CustomPropertyEvent.CustomProperty CustomProperty { get; init; } = null!;
 }

src/Octokit.Webhooks/Events/CustomPropertyEvent.cs

@@ -3,8 +3,4 @@ namespace Octokit.Webhooks.Events;
 [PublicAPI]
 [WebhookEventType(WebhookEventType.CustomProperty)]
 [JsonConverter(typeof(WebhookConverter<CustomPropertyEvent>))]
-public abstract record CustomPropertyEvent : WebhookEvent
-{
-    [JsonPropertyName("property_name")]
-    public string PropertyName { get; init; } = null!;
-}
+public abstract record CustomPropertyEvent : WebhookEvent;

src/Octokit.Webhooks/Events/CustomPropertyValues/CustomPropertyValuesUpdatedEvent.cs

@@ -2,8 +2,14 @@ namespace Octokit.Webhooks.Events.CustomPropertyValues;
 
 [PublicAPI]
 [WebhookActionType(CustomPropertyValuesActionValue.Updated)]
-public abstract record CustomPropertyValuesUpdatedEvent : CustomPropertyValuesEvent
+public sealed record CustomPropertyValuesUpdatedEvent : CustomPropertyValuesEvent
 {
     [JsonPropertyName("action")]
     public override string Action => CustomPropertyValuesAction.Updated;
+
+    [JsonPropertyName("new_property_values")]
+    public IEnumerable<Models.CustomPropertyValuesEvent.CustomPropertyValue> NewPropertyValues { get; init; } = null!;
+
+    [JsonPropertyName("old_property_values")]
+    public IEnumerable<Models.CustomPropertyValuesEvent.CustomPropertyValue> OldPropertyValues { get; init; } = null!;
 }

src/Octokit.Webhooks/Events/CustomPropertyValuesEvent.cs

@@ -1,15 +1,6 @@
-using Octokit.Webhooks.Models.CustomPropertyValues;
-
 namespace Octokit.Webhooks.Events;
 
 [PublicAPI]
 [WebhookEventType(WebhookEventType.CustomPropertyValues)]
 [JsonConverter(typeof(WebhookConverter<CustomPropertyValuesEvent>))]
-public abstract record CustomPropertyValuesEvent : WebhookEvent
-{
-    [JsonPropertyName("new_property_values")]
-    public IEnumerable<CustomPropertyValue> NewPropertyValues { get; init; } = null!;
-
-    [JsonPropertyName("old_property_values")]
-    public IEnumerable<CustomPropertyValue> OldPropertyValues { get; init; } = null!;
-}
+public abstract record CustomPropertyValuesEvent : WebhookEvent;

src/Octokit.Webhooks/Models/AppEvent.cs

@@ -21,6 +21,10 @@ public enum AppEvent
     ContentReference,
     [EnumMember(Value = "create")]
     Create,
+    [EnumMember(Value = "custom_property")]
+    CustomProperty,
+    [EnumMember(Value = "custom_property_values")]
+    CustomPropertyValues,
     [EnumMember(Value = "delete")]
     Delete,
     [EnumMember(Value = "deploy_key")]

src/Octokit.Webhooks/Models/AppPermissions.cs

@@ -74,6 +74,10 @@ public sealed record AppPermissions
     [JsonConverter(typeof(StringEnumConverter<AppPermissionsLevel>))]
     public StringEnum<AppPermissionsLevel>? OrganizationAdministration { get; init; }
 
+    [JsonPropertyName("organization_custom_properties")]
+    [JsonConverter(typeof(StringEnumConverter<AppPermissionsLevel>))]
+    public StringEnum<AppPermissionsLevel>? OrganizationCustomProperties { get; init; }
+
     [JsonPropertyName("organization_hooks")]
     [JsonConverter(typeof(StringEnumConverter<AppPermissionsLevel>))]
     public StringEnum<AppPermissionsLevel>? OrganizationHooks { get; init; }
@@ -117,6 +121,10 @@ public sealed record AppPermissions
     [JsonConverter(typeof(StringEnumConverter<AppPermissionsLevel>))]
     public StringEnum<AppPermissionsLevel>? PullRequests { get; init; }
 
+    [JsonPropertyName("repository_custom_properties")]
+    [JsonConverter(typeof(StringEnumConverter<AppPermissionsLevel>))]
+    public StringEnum<AppPermissionsLevel>? RepositoryCustomProperties { get; init; }
+
     [JsonPropertyName("repository_hooks")]
     [JsonConverter(typeof(StringEnumConverter<AppPermissionsLevel>))]
     public StringEnum<AppPermissionsLevel>? RepositoryHooks { get; init; }

src/Octokit.Webhooks/Models/CustomPropertyEvent/CustomProperty.cs

@@ -0,0 +1,28 @@
+namespace Octokit.Webhooks.Models.CustomPropertyEvent;
+
+[PublicAPI]
+public sealed record CustomProperty
+{
+    [JsonPropertyName("property_name")]
+    public string PropertyName { get; init; } = null!;
+
+    [JsonPropertyName("value_type")]
+    [JsonConverter(typeof(StringEnumConverter<CustomPropertyValueType>))]
+    public StringEnum<CustomPropertyValueType> ValueType { get; init; } = null!;
+
+    [JsonPropertyName("required")]
+    public bool Required { get; init; }
+
+    [JsonPropertyName("default_value")]
+    public string? DefaultValue { get; init; }
+
+    [JsonPropertyName("description")]
+    public string? Description { get; init; }
+
+    [JsonPropertyName("allowed_values")]
+    public IEnumerable<string>? AllowedValues { get; init; }
+
+    [JsonPropertyName("values_editable_by")]
+    [JsonConverter(typeof(StringEnumConverter<CustomPropertyValuesEditableBy>))]
+    public StringEnum<CustomPropertyValuesEditableBy>? ValuesEditableBy { get; init; }
+}

src/Octokit.Webhooks/Models/CustomPropertyEvent/CustomPropertyLite.cs

@@ -0,0 +1,8 @@
+namespace Octokit.Webhooks.Models.CustomPropertyEvent;
+
+[PublicAPI]
+public sealed record CustomPropertyLite
+{
+    [JsonPropertyName("property_name")]
+    public string PropertyName { get; init; } = null!;
+}