paddle 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f2fe0be6f1d67cf05754443625e3215781b9287eb5f9ae392628bea8946d123
-  data.tar.gz: 9beae56495831d56f8e4f7514e98a103e7d2de4f2c10d261492af3155769c4cc
+  metadata.gz: 607f60ab0594b5db91351073eeb83eec476bd3c2ddcf4cf52ff9815f83c13991
+  data.tar.gz: e7b3ba70a236938302823fa40828229cbe60c6c1c88bcb1cee0b40a06c5a32c0
 SHA512:
-  metadata.gz: 4ef63cdeefc3866e18364a28b76e65ad769d434107c19751bdaee7e1df8c10e64c53c5209c9e49184ba53b762899a97a7024f2d23d5a16e5afe9143065249def
-  data.tar.gz: c02668566acec530cf75e35aea6ba49d385a000d5a6f251ce2c348ada34be126252de860499ebc7a76bff51b94a316f89d67da4ab286612742add69460b6dfd9
+  metadata.gz: ffcc395ce5bb7de1ba92ace950bbeab8abb537609df89ea1c635e574f7519a519549b85570cda7226b6db52a5a85d69d7ad59c8a51bed1c59e187cd12b72d485
+  data.tar.gz: c5b224ba8bdbe5e60db6a28880ec1580c8c08cda5c230338f499a876e8792bf5862be6a75ae31b70fc93b4402508be98febbbef51c8e0117beeff5eaded62b37

data/Gemfile.lock

@@ -1,74 +1,76 @@
 PATH
   remote: .
   specs:
-    paddle (2.5.1)
-      faraday (~> 2.0)
+    paddle (2.6.0)
+      faraday (~> 2.11.0)
+      ostruct (~> 0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.4)
+    activesupport (7.2.1)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     ast (2.4.2)
-    base64 (0.1.1)
+    base64 (0.2.0)
     bigdecimal (3.1.8)
-    concurrent-ruby (1.3.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
-    dotenv (2.7.6)
+    dotenv (3.1.2)
     drb (2.2.1)
-    faraday (2.7.11)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    faraday (2.11.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      logger
+    faraday-net_http (3.3.0)
+      net-http
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
-    minitest (5.19.0)
-    mutex_m (0.2.0)
-    parallel (1.25.1)
-    parser (3.3.3.0)
+    logger (1.6.1)
+    minitest (5.25.1)
+    net-http (0.4.1)
+      uri
+    ostruct (0.6.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
-    racc (1.8.0)
+    racc (1.8.1)
     rack (3.1.7)
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.3.6)
-      strscan
-    rubocop (1.64.1)
+    rubocop (1.66.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+    rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
-    rubocop-minitest (0.35.0)
+    rubocop-minitest (0.36.0)
       rubocop (>= 1.61, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-performance (1.21.0)
+    rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.25.0)
+    rubocop-rails (2.26.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
+      rubocop (>= 1.52.0, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rails-omakase (1.0.0)
       rubocop
@@ -76,12 +78,13 @@ GEM
       rubocop-performance
       rubocop-rails
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    strscan (3.1.0)
+    securerandom (0.3.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
-    vcr (6.2.0)
+    uri (0.13.1)
+    vcr (6.3.1)
+      base64
 
 PLATFORMS
   x86_64-linux

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
@@ -358,6 +358,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 +467,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/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.1"
+  VERSION = "2.6.0"
 end

data/lib/paddle.rb

@@ -43,6 +43,10 @@ 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 :NotificationLog, "paddle/models/notification_log"
   autoload :CreditBalance, "paddle/models/credit_balance"

data/paddle.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = [ "lib" ]
 
-  spec.add_dependency "faraday", "~> 2.0"
+  spec.add_dependency "faraday", "~> 2.11.0"
+  spec.add_dependency "ostruct", "~> 0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paddle
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-04 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description:
 email:
 - dean@deanpcmad.com
@@ -87,6 +101,10 @@ files:
 - 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