paddle 1.1.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cabbd55e9adf58c1c43d55f2ffa55d7e908a71d5788f49e93de4534417d6f05
-  data.tar.gz: 621a1c186505c9661569e68086af31aff3445678a9d3105350ed88a929ea33c2
+  metadata.gz: fa102f9ad5b6adcf43a522ef2fd512d16e8493b186aa8129c5c6014751fa4274
+  data.tar.gz: 8d13d5a6cd7420bad3bca2f38057327ac44392db4022dac8edbc013cb1470091
 SHA512:
-  metadata.gz: b8bae12cc32ec34abd04593fe4d3514479e11a9125e17f54a612a48514954475d2e453cb1218a11310b4f8081b0d17ba5472e417ad8590e461a616dd0383a5e4
-  data.tar.gz: f90b9a773cee08b7c4cb8fe1d2794cb0c0cf961c0b0878f8c9bc228090043896727250cee95097fb6b605ac0c424e60f6f75ce28066d29d96f5480dd3322d0a1
+  metadata.gz: 2fdbf156519a8bce53914f2cf034b224a8249499029c773d7f7f167433252da2f90e733773ac0dcb9ff1b2314271b6dd7f22bfdddfe7acbc41e6772b6b71c508
+  data.tar.gz: 1af00167e992c18f7af0110ebc66540dd0b7b1928ba3db77e69dd87c79a3f2505c1d66153447dce34f161b6c8c9eeb4317312e0531dd0a862eeb1806a2735240

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paddle (1.1.2)
+    paddle (2.1.0)
       faraday (~> 2.0)
 
 GEM

data/README.md

@@ -7,7 +7,7 @@ A Ruby library for the Paddle APIs, both Classic and Billing.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "paddle"
+gem "paddle", "~> 2.1"
 ```
 
 ## Billing API
@@ -27,6 +27,9 @@ Paddle.configure do |config|
   # Or use :production for the Production API
   config.environment = :sandbox
   config.api_key = ENV["PADDLE_API_KEY"]
+
+  # Set the API version. Defaults to 1
+  config.version = 1
 end
 ```
 
@@ -183,6 +186,10 @@ Paddle::Transaction.create(items: [ { price_id: "pri_abc123", quantity: 1 } ])
 # Retrieve a transaction
 Paddle::Transaction.retrieve(id: "txn_abc123")
 
+# Retrieve a transaction with extra information
+# extra can be either "address", "adjustment", "adjustments_totals", "business", "customer", "discount"
+Paddle::Transaction.retrieve(id: "txn_abc123", extra: "customer")
+
 # Update a transaction
 # https://developer.paddle.com/api-reference/transaction/update-transaction
 Paddle::Transaction.update(id: "txn_abc123", items: [ { price_id: "pri_abc123", quantity: 2 } ])
@@ -211,6 +218,10 @@ Paddle::Subscription.list(status: "canceled")
 # Retrieve a subscription
 Paddle::Subscription.retrieve(id: "sub_abc123")
 
+# Retrieve a subscription with extra information
+# extra can be either "next_transaction" or "recurring_transaction_details"
+Paddle::Subscription.retrieve(id: "sub_abc123", extra: "next_transaction")
+
 # Preview an update to a subscription
 # https://developer.paddle.com/api-reference/subscriptions/preview-subscription
 Paddle::Subscription.preview(id: "sub_abc123", items: [ { price_id: "pri_123abc", quantity: 2 } ])

data/lib/paddle/client.rb

@@ -8,7 +8,8 @@ module Paddle
           conn.request :authorization, :Bearer, Paddle.config.api_key
 
           conn.headers = {
-            "User-Agent" => "paddle/v#{VERSION} (github.com/deanpcmad/paddle)"
+            "User-Agent" => "paddle/v#{VERSION} (github.com/deanpcmad/paddle)",
+            "Paddle-Version" => Paddle.config.version.to_s
           }
 
           conn.request :json

data/lib/paddle/configuration.rb

@@ -5,10 +5,12 @@ module Paddle
 
     attr_reader :environment
 
+    attr_accessor :version
     attr_accessor :api_key
 
     def initialize
       @environment ||= :production
+      @version ||= 1
     end
 
     def environment=(env)

data/lib/paddle/models/subscription.rb

@@ -8,8 +8,9 @@ module Paddle
         Collection.from_response(response, type: Subscription)
       end
 
-      def retrieve(id:)
-        response = Client.get_request("subscriptions/#{id}")
+      def retrieve(id:, extra: nil)
+        params = extra ? {include: extra} : {}
+        response = Client.get_request("subscriptions/#{id}", params: params)
         Subscription.new(response.body["data"])
       end
 

data/lib/paddle/models/transaction.rb

@@ -14,8 +14,9 @@ module Paddle
         Transaction.new(response.body["data"])
       end
 
-      def retrieve(id:)
-        response = Client.get_request("transactions/#{id}")
+      def retrieve(id:, extra: nil)
+        params = extra ? {include: extra} : {}
+        response = Client.get_request("transactions/#{id}", params: params)
         Transaction.new(response.body["data"])
       end
 

data/lib/paddle/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paddle
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-20 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday