feat: add deprecation notice to enum members and resources (#244)

Modern-Treasury · Feb 25, 2025 · fb72692 · fb72692
1 parent 3a44bf4
commit fb72692
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 3 deletions.
diff --git a/lib/modern_treasury/client.rb b/lib/modern_treasury/client.rb
@@ -15,11 +15,9 @@ class Client < ModernTreasury::BaseClient
     # Default max retry delay in seconds.
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
-    # Client option
     # @return [String]
     attr_reader :api_key
 
-    # Client option
     # @return [String]
     attr_reader :organization_id
 

diff --git a/lib/modern_treasury/models/counterparty_create_params.rb b/lib/modern_treasury/models/counterparty_create_params.rb
@@ -836,7 +836,7 @@ class PaymentType < ModernTreasury::Enum
       #
       # @deprecated
       #
-      #   An optional type to auto-sync the counterparty to your ledger. Either `customer`
+      # An optional type to auto-sync the counterparty to your ledger. Either `customer`
       #   or `vendor`.
       #
       # @example

diff --git a/lib/modern_treasury/models/ledger_event_handler.rb b/lib/modern_treasury/models/ledger_event_handler.rb
@@ -2,6 +2,8 @@
 
 module ModernTreasury
   module Models
+    # @deprecated
+    #
     class LedgerEventHandler < ModernTreasury::BaseModel
       # @!attribute id
       #
@@ -114,6 +116,8 @@ class LedgerEventHandler < ModernTreasury::BaseModel
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
+      # @deprecated
+      #
       class Conditions < ModernTreasury::BaseModel
         # @!attribute field
         #   The LHS of the conditional.
@@ -143,6 +147,8 @@ class Conditions < ModernTreasury::BaseModel
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
       end
 
+      # @deprecated
+      #
       class LedgerTransactionTemplate < ModernTreasury::BaseModel
         # @!attribute description
         #   An optional description for internal use.
@@ -180,6 +186,8 @@ class LedgerTransactionTemplate < ModernTreasury::BaseModel
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
+        # @deprecated
+        #
         class LedgerEntry < ModernTreasury::BaseModel
           # @!attribute amount
           #   The LHS of the conditional.

diff --git a/lib/modern_treasury/models/ledger_event_handler_create_params.rb b/lib/modern_treasury/models/ledger_event_handler_create_params.rb
@@ -82,6 +82,8 @@ class LedgerEventHandlerCreateParams < ModernTreasury::BaseModel
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
+      # @deprecated
+      #
       class LedgerTransactionTemplate < ModernTreasury::BaseModel
         # @!attribute description
         #   An optional description for internal use.
@@ -119,6 +121,8 @@ class LedgerTransactionTemplate < ModernTreasury::BaseModel
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
+        # @deprecated
+        #
         class LedgerEntry < ModernTreasury::BaseModel
           # @!attribute amount
           #   The LHS of the conditional.
@@ -149,6 +153,8 @@ class LedgerEntry < ModernTreasury::BaseModel
         end
       end
 
+      # @deprecated
+      #
       class Conditions < ModernTreasury::BaseModel
         # @!attribute field
         #   The LHS of the conditional.

diff --git a/lib/modern_treasury/models/ledger_event_handler_variable.rb b/lib/modern_treasury/models/ledger_event_handler_variable.rb
@@ -2,6 +2,8 @@
 
 module ModernTreasury
   module Models
+    # @deprecated
+    #
     class LedgerEventHandlerVariable < ModernTreasury::BaseModel
       # @!attribute query
       #
@@ -23,6 +25,8 @@ class LedgerEventHandlerVariable < ModernTreasury::BaseModel
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
+      # @deprecated
+      #
       class Query < ModernTreasury::BaseModel
         # @!attribute field
         #   The LHS of the conditional.

diff --git a/lib/modern_treasury/models/ledgerable_event.rb b/lib/modern_treasury/models/ledgerable_event.rb
@@ -2,6 +2,8 @@
 
 module ModernTreasury
   module Models
+    # @deprecated
+    #
     class LedgerableEvent < ModernTreasury::BaseModel
       # @!attribute id
       #