paddle 2.5.2 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71e0e3132d58b4212af739b9f9038ffe69a38e97b957a7f8b5c716a19cb12e97
-  data.tar.gz: 3cba717fe19593113c4f5f08d6e659b42033635bd8b39bfd4cfc60774cb3526a
+  metadata.gz: 30077dce563178db3e9407b4ef168bb1a24aabb324370a00ea37730eb926dbe6
+  data.tar.gz: 5ae2b0845d75b6fdcc001aadcf204c879d7596c13ab544f34d42192d5984cb04
 SHA512:
-  metadata.gz: 1e4a5ee39bb69fcfa8fcf6ada329c4b37c8e13822bfb379e34612d3080fd7560f766002f57fcc5eadf2b6d1189508472f2466247f8dc3b7e6981a8a6f8c5e255
-  data.tar.gz: e6531690ae2c71245364d98a14254dee36a896783d039df34bf090603f78ee1bbe0cb5098353fe35a67957eddd650dbfff9f3c64b0c7e7e3d7d1d119c59ce36a
+  metadata.gz: 2f4ed6ef5a1be40bb0c447c22b6ebe27f8527c9b69f0d7ca2ea6f17fd52470d8581f6b6039d7f245a66a936219bce1e4b97a97556042da95c9d2d57930169fdf
+  data.tar.gz: 8eafdbd49ed16fe04f0f815e99889578f0e6045115ede50c3b17aaf21203110a5f9349b8e8aeeced3e4b8145e443ca481bf6c11c810e9e055bab771ed1c58e10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paddle (2.5.2)
+    paddle (2.7.0)
       faraday (~> 2.11.0)
       ostruct (~> 0.6.0)
 

data/README.md

@@ -7,7 +7,7 @@ The easiest and most complete Ruby library for the Paddle APIs, both Classic and
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "paddle", "~> 2.5"
+gem "paddle", "~> 2.6"
 ```
 
 ## Billing API
@@ -336,6 +336,16 @@ Paddle::Subscription.cancel(id: "sub_abc123", effective_from: "immediately")
 Paddle::Subscription.activate(id: "sub_abc123")
 ```
 
+### Customer Portal Sessions
+
+```ruby
+# Create a Customer Portal Session
+# https://developer.paddle.com/api-reference/customer-portals/create-customer-portal-session
+Paddle::PortalSession.create customer: "ctm_abc123"
+Paddle::PortalSession.create customer: "ctm_abc123", subscription_ids: ["sub_abc123"]
+```
+
+
 ### Adjustments
 
 ```ruby
@@ -358,6 +368,12 @@ Paddle::Adjustment.create(
     }
   ]
 )
+
+# Get a credit note for an adjustment
+# disposition defaults to "attachment"
+# Returns a raw URL. This URL is not permanent and will expire.
+# https://developer.paddle.com/api-reference/adjustments/get-credit-note-pdf
+Paddle::Adjustment.credit_note(id: "adj_abc123", disposition: "inline")
 ```
 
 ### Event Types
@@ -461,6 +477,53 @@ Paddle::Report.create(
 )
 ```
 
+### Webhook Simulation Types
+
+Retrieves a list of Simulation Types - https://developer.paddle.com/api-reference/simulation-types/overview
+
+```ruby
+Paddle::SimulationType.list
+```
+
+### Webhook Simulations
+
+```ruby
+# List all simulations
+Paddle::Simulation.list
+Paddle::Simulation.list(status: "archived")
+Paddle::Simulation.list(notification_setting_id: "nftset_abc123")
+
+# Create a simulation
+# https://developer.paddle.com/api-reference/simulations/create-simulation
+Paddle::Simulation.create(notification_setting_id: "ntfset_abc123", name: "Customer Create", type: "customer.completed")
+Paddle::Simulation.create(notification_setting_id: "ntfset_abc123", name: "Subscription Created", type: "subscription_creation")
+
+# Retrieve a simulation
+Paddle::Simulation.retrieve(id: "ntfsim_abc123")
+
+# Update a simulation
+# https://developer.paddle.com/api-reference/simulations/update-simulation
+Paddle::Simulation.update(id: "ntfsim_abc123", name: "Simulation 2")
+Paddle::Simulation.update(id: "ntfsim_abc123", status: "archived")
+
+# List all simulation runs
+Paddle::Simulation.runs(id: "ntfsim_abc123")
+
+# Create a simulation run
+# https://developer.paddle.com/api-reference/simulations/create-simulation-run
+Paddle::SimulationRun.create(simulation_id: "ntfsim_abc123")
+
+# Retrieve a simulation run
+Paddle::SimulationRun.retrieve(simulation_id: "ntfsim_abc123", id: "ntfsimrun_abc123")
+
+# List all simulation run events
+Paddle::SimulationRun.events(simulation_id: "ntfsim_abc123", run_id: "ntfsimrun_abc123")
+
+# Replay a simulation run event
+# https://developer.paddle.com/api-reference/simulations/replay-simulation-run-event
+Paddle::SimulationRunEvent.replay(simulation_id: "ntfsim_abc123", run_id: "ntfsimrun_abc123", id: "ntfsimevt_abc123")
+```
+
 ## Classic API
 
 For accessing the Paddle Classic API

data/lib/paddle/models/adjustment.rb

@@ -11,6 +11,13 @@ module Paddle
         response = Client.post_request("adjustments", body: attrs.merge(params))
         Adjustment.new(response.body["data"])
       end
+
+      def credit_note(id:, disposition: "attachment")
+        response = Client.get_request("adjustments/#{id}/credit-note?disposition=#{disposition}")
+        if response.success?
+          response.body["data"]["url"]
+        end
+      end
     end
   end
 end

data/lib/paddle/models/portal_session.rb

@@ -0,0 +1,10 @@
+module Paddle
+  class PortalSession < Object
+    class << self
+      def create(customer:, **params)
+        response = Client.post_request("customers/#{customer}/portal-sessions", body: params)
+        PortalSession.new(response.body["data"])
+      end
+    end
+  end
+end

data/lib/paddle/models/simulation.rb

@@ -0,0 +1,31 @@
+module Paddle
+  class Simulation < Object
+    class << self
+      def list(**params)
+        response = Client.get_request("simulations", params: params)
+        Collection.from_response(response, type: Simulation)
+      end
+
+      def create(setting_id:, name:, type:, **params)
+        attrs = { notification_setting_id: setting_id, name: name, type: type }
+        response = Client.post_request("simulations", body: attrs.merge(params))
+        Simulation.new(response.body["data"])
+      end
+
+      def retrieve(id:)
+        response = Client.get_request("simulations/#{id}")
+        Simulation.new(response.body["data"])
+      end
+
+      def update(id:, **params)
+        response = Client.patch_request("simulations/#{id}", body: params)
+        Simulation.new(response.body["data"])
+      end
+
+      def runs(id:)
+        response = Client.get_request("simulations/#{id}/runs")
+        Collection.from_response(response, type: SimulationRun)
+      end
+    end
+  end
+end

data/lib/paddle/models/simulation_run.rb

@@ -0,0 +1,20 @@
+module Paddle
+  class SimulationRun < Object
+    class << self
+      def create(simulation_id:, **params)
+        response = Client.post_request("simulations/#{simulation_id}/runs", body: {})
+        SimulationRun.new(response.body["data"])
+      end
+
+      def retrieve(simulation_id:, id:)
+        response = Client.get_request("simulations/#{simulation_id}/runs/#{id}")
+        SimulationRun.new(response.body["data"])
+      end
+
+      def events(simulation_id:, id:)
+        response = Client.get_request("simulations/#{simulation_id}/runs/#{id}/events")
+        Collection.from_response(response, type: SimulationRunEvent)
+      end
+    end
+  end
+end

data/lib/paddle/models/simulation_run_event.rb

@@ -0,0 +1,15 @@
+module Paddle
+  class SimulationRunEvent < Object
+    class << self
+      def retrieve(simulation_id:, run_id:, id:)
+        response = Client.get_request("simulations/#{simulation_id}/runs/#{run_id}/events/#{id}")
+        SimulationRunEvent.new(response.body["data"])
+      end
+
+      def replay(simulation_id:, run_id:, id:)
+        response = Client.post_request("simulations/#{simulation_id}/runs/#{run_id}/events/#{id}/replay")
+        SimulationRunEvent.new(response.body["data"])
+      end
+    end
+  end
+end

data/lib/paddle/models/simulation_type.rb

@@ -0,0 +1,10 @@
+module Paddle
+  class SimulationType < Object
+    class << self
+      def list
+        response = Client.get_request("simulation-types")
+        Collection.from_response(response, type: SimulationType)
+      end
+    end
+  end
+end

data/lib/paddle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paddle
-  VERSION = "2.5.2"
+  VERSION = "2.7.0"
 end

data/lib/paddle.rb

@@ -43,6 +43,11 @@ module Paddle
   autoload :NotificationSetting, "paddle/models/notification_setting"
   autoload :Notification, "paddle/models/notification"
   autoload :Report, "paddle/models/report"
+  autoload :SimulationType, "paddle/models/simulation_type"
+  autoload :Simulation, "paddle/models/simulation"
+  autoload :SimulationRun, "paddle/models/simulation_run"
+  autoload :SimulationRunEvent, "paddle/models/simulation_run_event"
+  autoload :PortalSession, "paddle/models/portal_session"
 
   autoload :NotificationLog, "paddle/models/notification_log"
   autoload :CreditBalance, "paddle/models/credit_balance"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paddle
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.7.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -97,10 +97,15 @@ files:
 - lib/paddle/models/notification.rb
 - lib/paddle/models/notification_log.rb
 - lib/paddle/models/notification_setting.rb
+- lib/paddle/models/portal_session.rb
 - lib/paddle/models/price.rb
 - lib/paddle/models/pricing_preview.rb
 - lib/paddle/models/product.rb
 - lib/paddle/models/report.rb
+- lib/paddle/models/simulation.rb
+- lib/paddle/models/simulation_run.rb
+- lib/paddle/models/simulation_run_event.rb
+- lib/paddle/models/simulation_type.rb
 - lib/paddle/models/subscription.rb
 - lib/paddle/models/transaction.rb
 - lib/paddle/object.rb
@@ -126,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Ruby library for the Paddle Billing & Classic APIs