README.md in paddle-2.5.2 vs README.md in paddle-2.6.0

- old
+ new

@@ -5,11 +5,11 @@ ## Installation Add this line to your application's Gemfile: ```ruby -gem "paddle", "~> 2.5" +gem "paddle", "~> 2.6" ``` ## Billing API For accessing the new Billing API from Paddle. For more info, view the [Paddle Billing](https://www.paddle.com/billing) page. @@ -356,10 +356,16 @@ type: "full", item_id: "txnitm_anc123" } ] ) + +# 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 ```ruby @@ -457,9 +463,56 @@ filters: [ {name: "updated_at", operator: "lt", value: "2024-04-30"}, {name: "updated_at", operator: "gte", value: "2024-04-01"} ] ) +``` + +### 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