paddle 2.1.4 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18ca722e2dfa03afa07ccc605919184d6f13ebb594c163c5f4ea0ff2bb4ab242
-  data.tar.gz: d4d42ff9ab6370b90ecc965a26a936fcabffd455f98d88a1bc43ed39779e6f91
+  metadata.gz: 6224fc2a3ec9423990985241a118780185a090617407f95e97bb542120eb9323
+  data.tar.gz: 03403341d8dce73c881ed3fc2c722cf738b625803c6352dd2cca15e5d4cd65a7
 SHA512:
-  metadata.gz: 9a33e4d7f8462e8c4a987d6bc621b920e29b6aada8cc1076f204e38f9cac69fa733dfed1f12e5447ec4dd148db25b0a0fd01ef39641534dc2ba7466b95416451
-  data.tar.gz: 697890a2b7465aa1b563fef5e4a388792dbe4325e22582fa16d8b727b5dab2d49702fd90859bbdd056709cba7ad16977706ef463965b1d51ebf35c7a1216c46b
+  metadata.gz: 6453da01350a80adf7f8723817b7d45edfac636d5ae72ebeb92b281ad93d85d59866631eb60a17c3a8225f5a8f51780b857e1aeab940c0264daaa53446a70637
+  data.tar.gz: 716ef3061039df26a5cfc0dd0f8931cb1e9edcf964947047acf37ed8b95cc63a3cc36595288f6aaccc45ee2b1e3f8fe0b74ae39969123f2c99eeeeea9da41381

data/.rubocop.yml

@@ -0,0 +1,8 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+# Overwrite or add rules to create your own house style
+#
+# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
+# Layout/SpaceInsideArrayLiteralBrackets:
+#   Enabled: false

data/Gemfile

@@ -9,5 +9,5 @@ gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
 gem "dotenv"
-
 gem "vcr"
+gem "rubocop-rails-omakase", require: false

data/Gemfile.lock

@@ -1,22 +1,86 @@
 PATH
   remote: .
   specs:
-    paddle (2.1.4)
+    paddle (2.2.1)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
     base64 (0.1.1)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
     dotenv (2.7.6)
+    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)
+    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)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.0)
+    rack (3.1.3)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.9.2)
+    rexml (3.3.0)
+      strscan
+    rubocop (1.64.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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-minitest (0.35.0)
+      rubocop (>= 1.61, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.25.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails-omakase (1.0.0)
+      rubocop
+      rubocop-minitest
+      rubocop-performance
+      rubocop-rails
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    strscan (3.1.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
     vcr (6.2.0)
 
 PLATFORMS
@@ -27,7 +91,8 @@ DEPENDENCIES
   minitest (~> 5.0)
   paddle!
   rake (~> 13.0)
+  rubocop-rails-omakase
   vcr
 
 BUNDLED WITH
-   2.4.21
+   2.5.9

data/README.md

@@ -1,13 +1,13 @@
 # Paddle Ruby Library
 
-A Ruby library for the Paddle APIs, both Classic and Billing.
+The easiest and most complete Ruby library for the Paddle APIs, both Classic and Billing.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "paddle", "~> 2.1"
+gem "paddle", "~> 2.2"
 ```
 
 ## Billing API
@@ -33,10 +33,49 @@ Paddle.configure do |config|
 end
 ```
 
+### Resources
+
+The gem maps as closely as we can to the Paddle API so you can easily convert API examples to gem code.
+
+Responses are created as objects like `Paddle::Product`. Having types like `Paddle::Product` is handy for understanding what
+type of object you're working with. They're built using OpenStruct so you can easily access data in a Ruby-ish way.
+
+### Pagination
+
+Some of the endpoints return pages of results. The result object will have a `data` key to access the results.
+
+An example of using collections, including pagination:
+
+```ruby
+results = Paddle::Product.list(per_page: 10)
+#=> Paddle::Collection
+
+results.total
+#=> 10
+
+results.data
+#=> [#<Paddle::Product>, #<Paddle::Product>]
+
+results.each do |result|
+  puts result.id
+end
+
+results.first
+#=> #<Paddle::Product>
+
+results.last
+#=> #<Paddle::Product>
+
+# Retrieve the next page
+Paddle::Product.list(per_page: 10, after: "abc123")
+#=> Paddle::Collection
+```
+
 ### Caveats
 
-The Paddle API doesn't take `nil` values for optional parameters. If you want to
-remove a value, you'll need to pass `"null"` instead.
+>[!NOTE]
+>
+> The Paddle API doesn't take `nil` values for optional parameters. If you want to remove a value, you'll need to pass `"null"` instead.
 
 ### Products
 
@@ -369,6 +408,30 @@ Paddle::Notification.replay(id: "ntf_abc123")
 Paddle::Notification.logs(id: "ntf_abc123")
 ```
 
+### Reports
+
+```ruby
+# List all reports
+Paddle::Report.list
+
+# Retrieve a report
+Paddle::Report.retrieve(id: "rpt_abc123")
+
+# Get CSV download link for a report
+# Returns a raw URL. This URL is not permanent and will expire.
+# https://developer.paddle.com/api-reference/reports/get-report-csv
+Paddle::Report.csv(id: "rpt_abc123")
+
+# Create a Report
+# https://developer.paddle.com/api-reference/reports/create-report
+Paddle::Report.create(
+  type: "transactions",
+  filters: [
+    {name: "updated_at", operator: "lt", value: "2024-04-30"},
+    {name: "updated_at", operator: "gte", value: "2024-04-01"}
+  ]
+)
+```
 
 ## Classic API
 

data/lib/paddle/classic/client.rb

@@ -1,7 +1,6 @@
 module Paddle
   module Classic
     class Client
-
       BASE_URL = "https://vendors.paddle.com/api"
       SANDBOX_BASE_URL = "https://sandbox-vendors.paddle.com/api"
 

data/lib/paddle/classic/resource.rb

@@ -14,7 +14,7 @@ module Paddle
       # end
 
       def post_request(url, body: {}, headers: {})
-        attrs = {vendor_id: client.vendor_id, vendor_auth_code: client.vendor_auth_code}
+        attrs = { vendor_id: client.vendor_id, vendor_auth_code: client.vendor_auth_code }
         handle_response client.connection.post(url, attrs.merge(body), headers)
       end
 

data/lib/paddle/classic/resources/charges.rb

@@ -1,13 +1,11 @@
 module Paddle
   module Classic
     class ChargesResource < Resource
-
       def create(subscription_id:, amount:, charge_name:)
-        attrs = {amount: amount, charge_name: charge_name}
+        attrs = { amount: amount, charge_name: charge_name }
         response = post_request("2.0/subscription/#{subscription_id}/charge", body: attrs)
         Charge.new(response.body["response"])
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/coupons.rb

@@ -1,33 +1,31 @@
 module Paddle
   module Classic
     class CouponsResource < Resource
-
       def list(product_id:)
-        response = post_request("2.0/product/list_coupons", body: {product_id: product_id})
+        response = post_request("2.0/product/list_coupons", body: { product_id: product_id })
         Collection.from_response(response, type: Coupon)
       end
 
       def create(coupon_type:, discount_type:, discount_amount:, **params)
-        attrs = {coupon_type: coupon_type, discount_type: discount_type, discount_amount: discount_amount}
+        attrs = { coupon_type: coupon_type, discount_type: discount_type, discount_amount: discount_amount }
 
         response = post_request("2.1/product/create_coupon", body: attrs.merge(params))
 
         coupons =  response.body["response"]["coupon_codes"]
 
-        coupons.map {|c| Paddle::Coupon.new(code: c)}
+        coupons.map { |c| Paddle::Coupon.new(code: c) }
       end
 
       def delete(coupon_code:, product_id:)
-        attrs = {coupon_code: coupon_code, product_id: product_id}
+        attrs = { coupon_code: coupon_code, product_id: product_id }
         response = post_request("2.0/product/delete_coupon", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
 
       def update(**params)
         response = post_request("2.1/product/update_coupon", body: params)
-        return true if response.success?
+        true if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/licenses.rb

@@ -1,15 +1,13 @@
 module Paddle
   module Classic
     class LicensesResource < Resource
-
       def generate(product_id:, allowed_uses:, **params)
-        attrs = {product_id: product_id, allowed_uses: allowed_uses}
+        attrs = { product_id: product_id, allowed_uses: allowed_uses }
 
         response = post_request("2.0/product/generate_license", body: attrs.merge(params))
 
         License.new(response.body["response"]) if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/modifiers.rb

@@ -1,26 +1,24 @@
 module Paddle
   module Classic
     class ModifiersResource < Resource
-
       def list(**params)
         response = post_request("2.0/subscription/modifiers", body: params)
         Collection.from_response(response, type: Modifier)
       end
 
       def create(subscription_id:, modifier_amount:, **params)
-        attrs = {subscription_id: subscription_id, modifier_amount: modifier_amount}
+        attrs = { subscription_id: subscription_id, modifier_amount: modifier_amount }
         create_response = post_request("2.0/subscription/modifiers/create", body: attrs.merge(params))
 
-        response = post_request("2.0/subscription/modifiers", body: {subscription_id: subscription_id} )
+        response = post_request("2.0/subscription/modifiers", body: { subscription_id: subscription_id })
         Collection.from_response(response, type: Modifier)
       end
 
       def delete(modifier_id:)
-        attrs = {modifier_id: modifier_id}
+        attrs = { modifier_id: modifier_id }
         response = post_request("2.0/subscription/modifiers/delete", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/pay_links.rb

@@ -1,13 +1,11 @@
 module Paddle
   module Classic
     class PayLinksResource < Resource
-
       def generate(**params)
         response = post_request("2.0/product/generate_pay_link", body: params)
 
         PayLink.new(response.body["response"]) if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/payments.rb

@@ -1,24 +1,22 @@
 module Paddle
   module Classic
     class PaymentsResource < Resource
-
       def list(**params)
         response = post_request("2.0/subscription/payments", body: params)
         Collection.from_response(response, type: Payment)
       end
 
       def reschedule(payment_id:, date:)
-        attrs = {payment_id: payment_id, date: date}
+        attrs = { payment_id: payment_id, date: date }
         response = post_request("2.0/subscription/payments_reschedule", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
 
       def refund(order_id:, **params)
-        attrs = {order_id: order_id}
+        attrs = { order_id: order_id }
         response = post_request("2.0/payment/refund", body: attrs.merge(params))
         PaymentRefund.new(response.body["response"])
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/plans.rb

@@ -1,21 +1,19 @@
 module Paddle
   module Classic
     class PlansResource < Resource
-
       def list
         response = post_request("2.0/subscription/plans")
         Collection.from_response(response, type: Plan)
       end
 
       def create(name:, type:, **params)
-        attrs = {plan_name: name, plan_type: type}
+        attrs = { plan_name: name, plan_type: type }
         create_response = post_request("2.0/subscription/plans_create", body: attrs.merge(params))
 
         # After creating the Plan, because it doesn't return the whole record, grab it from the API and return that
-        response = post_request("2.0/subscription/plans", body: {plan: create_response.body["response"]["product_id"]} )
+        response = post_request("2.0/subscription/plans", body: { plan: create_response.body["response"]["product_id"] })
         Plan.new(response.body.dig("response")[0]) if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/products.rb

@@ -1,12 +1,10 @@
 module Paddle
   module Classic
     class ProductsResource < Resource
-
       def list
         response = post_request("2.0/product/get_products")
         Collection.from_response(response, type: Product, key: "products")
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/transactions.rb

@@ -1,12 +1,10 @@
 module Paddle
   module Classic
     class TransactionsResource < Resource
-
       def list(entity:, id:)
         response = post_request("2.0/#{entity}/#{id}/transactions")
         Collection.from_response(response, type: Transaction)
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/users.rb

@@ -1,42 +1,40 @@
 module Paddle
   module Classic
     class UsersResource < Resource
-
       def list(**params)
         response = post_request("2.0/subscription/users", body: params)
         Collection.from_response(response, type: User)
       end
 
       def update(subscription_id:, **params)
-        attrs = {subscription_id: subscription_id}
+        attrs = { subscription_id: subscription_id }
         response = post_request("2.0/subscription/users/update", body: attrs.merge(params))
         User.new(response.body["response"]) if response.success?
       end
 
       def pause(subscription_id:, **params)
-        attrs = {subscription_id: subscription_id, pause: true}
+        attrs = { subscription_id: subscription_id, pause: true }
         response = post_request("2.0/subscription/users/update", body: attrs.merge(params))
         User.new(response.body["response"]) if response.success?
       end
 
       def unpause(subscription_id:, **params)
-        attrs = {subscription_id: subscription_id, pause: false}
+        attrs = { subscription_id: subscription_id, pause: false }
         response = post_request("2.0/subscription/users/update", body: attrs.merge(params))
         User.new(response.body["response"]) if response.success?
       end
 
       def update_postcode(subscription_id:, postcode:)
-        attrs = {subscription_id: subscription_id, postcode: postcode}
+        attrs = { subscription_id: subscription_id, postcode: postcode }
         response = post_request("2.0/subscription/users/postcode", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
 
       def cancel(subscription_id:)
-        attrs = {subscription_id: subscription_id}
+        attrs = { subscription_id: subscription_id }
         response = post_request("2.0/subscription/users_cancel", body: attrs)
-        return true if response.success?
+        true if response.success?
       end
-
     end
   end
 end

data/lib/paddle/classic/resources/webhooks.rb

@@ -1,12 +1,10 @@
 module Paddle
   module Classic
     class WebhooksResource < Resource
-
       def list(**params)
         response = post_request("2.0/alert/webhooks", body: params)
         Collection.from_response(response, type: Webhook, key: "data")
       end
-
     end
   end
 end

data/lib/paddle/client.rb

@@ -1,8 +1,6 @@
 module Paddle
   class Client
-
     class << self
-
       def connection
         @connection ||= Faraday.new(Paddle.config.url) do |conn|
           conn.request :authorization, :Bearer, Paddle.config.api_key
@@ -13,8 +11,7 @@ module Paddle
           }
 
           conn.request :json
-
-          conn.response :json, content_type: "application/json"
+          conn.response :json
         end
       end
 
@@ -65,8 +62,6 @@ module Paddle
 
         response
       end
-
     end
-
   end
 end

data/lib/paddle/collection.rb

@@ -23,5 +23,17 @@ module Paddle
       @data = data
       @total = total
     end
+
+    def each(&block)
+      data.each(&block)
+    end
+
+    def first
+      data.first
+    end
+
+    def last
+      data.last
+    end
   end
 end

data/lib/paddle/configuration.rb

@@ -2,7 +2,6 @@
 
 module Paddle
   class Configuration
-
     attr_reader :environment
 
     attr_accessor :version
@@ -15,7 +14,7 @@ module Paddle
 
     def environment=(env)
       env = env.nil? ? :production : env.to_sym
-      unless [:development, :sandbox, :production].include?(env)
+      unless [ :development, :sandbox, :production ].include?(env)
         raise ArgumentError, "#{env.inspect} is not a valid environment"
       end
       @environment = env
@@ -29,6 +28,5 @@ module Paddle
         "https://sandbox-api.paddle.com"
       end
     end
-
   end
 end

data/lib/paddle/models/address.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Address < Object
-
     class << self
-
       def list(customer:, **params)
         response = Client.get_request("customers/#{customer}/addresses", params: params)
         Collection.from_response(response, type: Address)
       end
 
       def create(customer:, country_code:, postal_code:, **params)
-        attrs = {country_code: country_code, postal_code: postal_code}
+        attrs = { country_code: country_code, postal_code: postal_code }
         response = Client.post_request("customers/#{customer}/addresses", body: attrs.merge(params))
         Address.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("customers/#{customer}/addresses/#{id}", body: params)
         Address.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/adjustment.rb

@@ -1,20 +1,16 @@
 module Paddle
   class Adjustment < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("adjustments", params: params)
         Collection.from_response(response, type: Adjustment)
       end
 
       def create(transaction_id:, action:, reason:, items:, **params)
-        attrs = {transaction_id: transaction_id, action: action, reason: reason, items: items}
+        attrs = { transaction_id: transaction_id, action: action, reason: reason, items: items }
         response = Client.post_request("adjustments", body: attrs.merge(params))
         Adjustment.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/business.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Business < Object
-
     class << self
-
       def list(customer:, **params)
         response = Client.get_request("customers/#{customer}/businesses", params: params)
         Collection.from_response(response, type: Business)
       end
 
       def create(customer:, name:, **params)
-        attrs = {name: name}
+        attrs = { name: name }
         response = Client.post_request("customers/#{customer}/businesses", body: attrs.merge(params))
         Business.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("customers/#{customer}/businesses/#{id}", body: params)
         Business.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/customer.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Customer < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("customers", params: params)
         Collection.from_response(response, type: Customer)
       end
 
       def create(email:, **params)
-        attrs = {email: email.gsub(/\s+/, "")}
+        attrs = { email: email.gsub(/\s+/, "") }
         response = Client.post_request("customers", body: attrs.merge(params))
         Customer.new(response.body["data"])
       end
@@ -28,8 +26,6 @@ module Paddle
         response = Client.get_request("customers/#{id}/credit-balances")
         CreditBalance.new(response.body["data"][0])
       end
-
     end
-
   end
 end

data/lib/paddle/models/discount.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Discount < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("discounts", params: params)
         Collection.from_response(response, type: Discount)
       end
 
       def create(amount:, description:, type:, **params)
-        attrs = {amount: amount, description: description, type: type}
+        attrs = { amount: amount, description: description, type: type }
         response = Client.post_request("discounts", body: attrs.merge(params))
         Discount.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("discounts/#{id}", body: params)
         Discount.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/event.rb

@@ -1,14 +1,10 @@
 module Paddle
   class Event < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("events", params: params)
         Collection.from_response(response, type: Event)
       end
-
     end
-
   end
 end

data/lib/paddle/models/event_type.rb

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

data/lib/paddle/models/notification.rb

@@ -1,8 +1,6 @@
 module Paddle
   class Notification < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("notifications", params: params)
         Collection.from_response(response, type: Notification)
@@ -23,8 +21,6 @@ module Paddle
         response = Client.get_request("notifications/#{id}/logs", params: params)
         Collection.from_response(response, type: NotificationLog)
       end
-
     end
-
   end
 end

data/lib/paddle/models/notification_setting.rb

@@ -1,15 +1,13 @@
 module Paddle
   class NotificationSetting < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("notification-settings", params: params)
         Collection.from_response(response, type: NotificationSetting)
       end
 
       def create(description:, destination:, type:, subscribed_events:, **params)
-        attrs = {description: description, destination: destination, type: type, subscribed_events: subscribed_events}
+        attrs = { description: description, destination: destination, type: type, subscribed_events: subscribed_events }
         response = Client.post_request("notification-settings", body: attrs.merge(params))
         NotificationSetting.new(response.body["data"])
       end
@@ -27,8 +25,6 @@ module Paddle
       def delete(id:)
         Client.delete_request("notification-settings/#{id}")
       end
-
     end
-
   end
 end

data/lib/paddle/models/price.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Price < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("prices", params: params)
         Collection.from_response(response, type: Price)
       end
 
       def create(product_id:, description:, amount:, currency:, **params)
-        attrs = {product_id: product_id, description: description, unit_price: {amount: amount, currency_code: currency}}
+        attrs = { product_id: product_id, description: description, unit_price: { amount: amount, currency_code: currency } }
         response = Client.post_request("prices", body: attrs.merge(params))
         Price.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("prices/#{id}", body: params)
         Price.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/pricing_preview.rb

@@ -1,15 +1,11 @@
 module Paddle
   class PricingPreview < Object
-
     class << self
-
       def generate(items:, **params)
-        attrs = {items: items}
+        attrs = { items: items }
         response = Client.post_request("pricing-preview", body: attrs.merge(params))
         PricingPreview.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/product.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Product < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("products", params: params)
         Collection.from_response(response, type: Product)
       end
 
       def create(name:, tax_category:, **params)
-        attrs = {name: name, tax_category: tax_category}
+        attrs = { name: name, tax_category: tax_category }
         response = Client.post_request("products", body: attrs.merge(params))
         Product.new(response.body["data"])
       end
@@ -23,8 +21,6 @@ module Paddle
         response = Client.patch_request("products/#{id}", body: params)
         Product.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/report.rb

@@ -0,0 +1,28 @@
+module Paddle
+  class Report < Object
+    class << self
+      def list(**params)
+        response = Client.get_request("reports", params: params)
+        Collection.from_response(response, type: Report)
+      end
+
+      def create(type:, filters:, **params)
+        attrs = { type: type, filters: filters }
+        response = Client.post_request("reports", body: attrs.merge(params))
+        Report.new(response.body["data"])
+      end
+
+      def retrieve(id:)
+        response = Client.get_request("reports/#{id}")
+        Report.new(response.body["data"])
+      end
+
+      def csv(id:)
+        response = Client.get_request("reports/#{id}/download-url")
+        if response.success?
+          response.body["data"]["url"]
+        end
+      end
+    end
+  end
+end

data/lib/paddle/models/subscription.rb

@@ -1,15 +1,13 @@
 module Paddle
   class Subscription < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("subscriptions", params: params)
         Collection.from_response(response, type: Subscription)
       end
 
       def retrieve(id:, extra: nil)
-        params = extra ? {include: extra} : {}
+        params = extra ? { include: extra } : {}
         response = Client.get_request("subscriptions/#{id}", params: params)
         Subscription.new(response.body["data"])
       end
@@ -30,7 +28,7 @@ module Paddle
       end
 
       def charge(id:, items:, effective_from:, **params)
-        attrs = {items: items, effective_from: effective_from}
+        attrs = { items: items, effective_from: effective_from }
         response = Client.post_request("subscriptions/#{id}/charge", body: attrs.merge(params))
         Subscription.new(response.body["data"])
       end
@@ -41,7 +39,7 @@ module Paddle
       end
 
       def resume(id:, effective_from:, **params)
-        attrs = {effective_from: effective_from}
+        attrs = { effective_from: effective_from }
         response = Client.post_request("subscriptions/#{id}/resume", body: attrs.merge(params))
         Subscription.new(response.body["data"])
       end
@@ -55,8 +53,6 @@ module Paddle
         response = Client.post_request("subscriptions/#{id}/activate")
         Subscription.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/models/transaction.rb

@@ -1,21 +1,19 @@
 module Paddle
   class Transaction < Object
-
     class << self
-
       def list(**params)
         response = Client.get_request("transactions", params: params)
         Collection.from_response(response, type: Transaction)
       end
 
       def create(items:, **params)
-        attrs = {items: items}
+        attrs = { items: items }
         response = Client.post_request("transactions", body: attrs.merge(params))
         Transaction.new(response.body["data"])
       end
 
       def retrieve(id:, extra: nil)
-        params = extra ? {include: extra} : {}
+        params = extra ? { include: extra } : {}
         response = Client.get_request("transactions/#{id}", params: params)
         Transaction.new(response.body["data"])
       end
@@ -28,17 +26,15 @@ module Paddle
       def invoice(id:)
         response = Client.get_request("transactions/#{id}/invoice")
         if response.success?
-          return response.body["data"]["url"]
+          response.body["data"]["url"]
         end
       end
 
       def preview(items:, **params)
-        attrs = {items: items}
+        attrs = { items: items }
         response = Client.post_request("transactions/preview", body: attrs.merge(params))
         Transaction.new(response.body["data"])
       end
-
     end
-
   end
 end

data/lib/paddle/object.rb

@@ -8,7 +8,7 @@ module Paddle
 
     def to_ostruct(obj)
       if obj.is_a?(Hash)
-        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+        OpenStruct.new(obj.map { |key, val| [ key, to_ostruct(val) ] }.to_h)
       elsif obj.is_a?(Array)
         obj.map { |o| to_ostruct(o) }
       else # Assumed to be a primitive value

data/lib/paddle/version.rb

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

data/lib/paddle.rb

@@ -5,7 +5,6 @@ require "faraday"
 require_relative "paddle/version"
 
 module Paddle
-
   autoload :Configuration, "paddle/configuration"
   autoload :Client, "paddle/client"
   autoload :Collection, "paddle/collection"
@@ -39,6 +38,7 @@ module Paddle
   autoload :Event, "paddle/models/event"
   autoload :NotificationSetting, "paddle/models/notification_setting"
   autoload :Notification, "paddle/models/notification"
+  autoload :Report, "paddle/models/report"
 
   autoload :NotificationLog, "paddle/models/notification_log"
   autoload :CreditBalance, "paddle/models/credit_balance"
@@ -74,5 +74,4 @@ module Paddle
     autoload :Modifier, "paddle/classic/objects/modifier"
     autoload :Charge, "paddle/classic/objects/charge"
   end
-
 end

data/paddle.gemspec

@@ -5,8 +5,8 @@ require_relative "lib/paddle/version"
 Gem::Specification.new do |spec|
   spec.name          = "paddle"
   spec.version       = Paddle::VERSION
-  spec.authors       = ["Dean Perry"]
-  spec.email         = ["dean@deanpcmad.com"]
+  spec.authors       = [ "Dean Perry" ]
+  spec.email         = [ "dean@deanpcmad.com" ]
 
   spec.summary       = "Ruby library for the Paddle Billing & Classic APIs"
   spec.homepage      = "https://github.com/deanpcmad/paddle"
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = [ "lib" ]
 
   spec.add_dependency "faraday", "~> 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paddle
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.2.1
 platform: ruby
 authors:
 - Dean Perry
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - dean@deanpcmad.com
 executables: []
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -83,6 +84,7 @@ files:
 - lib/paddle/models/price.rb
 - lib/paddle/models/pricing_preview.rb
 - lib/paddle/models/product.rb
+- lib/paddle/models/report.rb
 - lib/paddle/models/subscription.rb
 - lib/paddle/models/transaction.rb
 - lib/paddle/object.rb
@@ -93,7 +95,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/deanpcmad/paddle
   source_code_uri: https://github.com/deanpcmad/paddle
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,8 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Ruby library for the Paddle Billing & Classic APIs
 test_files: []