paddle 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457fd5bd63d3324da10687d2796e4582e2693021ab8a6fa7bfeddbfa7b47dda0
-  data.tar.gz: 38ef8f0c9baf2ddc2515d1a3a1c9a032e5c3a8788299052762e4741f1f81e236
+  metadata.gz: b0c36c67374aa35e91a2497199311888ef26eb0265cd14dddf57f535e7dabb6e
+  data.tar.gz: 287d3e39a116eb4b19bba68baaa0772c67306e0f47249c81c815a29ab5a82f0f
 SHA512:
-  metadata.gz: c2c14b85b564116f6b5c3d771b010b4fefa66ef9e899960c6bd3fc9e0919a9e864b398d73106318e62c2bb8c4684a8a2f5b211ff9e6ec67fcdfd337b1b6465a8
-  data.tar.gz: c604c94ac7770198ed78f57318327efcbf293d68a127bfdfcb419a4aa52aa7ee4db8ac7542df3d9045b662d5a5b6a3cbea9aa3f02be7559b8e04232db6eb6c33
+  metadata.gz: 30ab0451e76ea879e948373553f707359e9847f92f9a06a1d962dad8f327e471d89858b505e27e7e030570db5413d161943b6aa29b7efe68dc26cdb9723bad7b
+  data.tar.gz: 10fd334a894063e6f14c69fb9e03d1931e9153877037b786cc127fec82d2ba4d0cf992ec1441ca4550ae469dcf444e8abf64404f4478573e28f834ab00d745e5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paddle (2.1.3)
+    paddle (2.2.0)
       faraday (~> 2.0)
 
 GEM
@@ -30,4 +30,4 @@ DEPENDENCIES
   vcr
 
 BUNDLED WITH
-   2.4.21
+   2.5.9

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", "~> 2.1"
+gem "paddle", "~> 2.2"
 ```
 
 ## Billing API
@@ -33,6 +33,11 @@ Paddle.configure do |config|
 end
 ```
 
+### 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.
+
 ### Products
 
 ```ruby
@@ -119,6 +124,7 @@ Paddle::Discount.update(id: "dsc_abc123", description: "An updated description")
 # https://developer.paddle.com/api-reference/customers/list-customers
 Paddle::Customer.list
 Paddle::Customer.list(status: "active")
+Paddle::Customer.list(email: "me@mydomain.com")
 
 # Create a customer
 # https://developer.paddle.com/api-reference/customers/create-customer
@@ -363,6 +369,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/configuration.rb

@@ -14,7 +14,7 @@ module Paddle
     end
 
     def environment=(env)
-      env = env.to_sym
+      env = env.nil? ? :production : env.to_sym
       unless [:development, :sandbox, :production].include?(env)
         raise ArgumentError, "#{env.inspect} is not a valid environment"
       end

data/lib/paddle/models/report.rb

@@ -0,0 +1,32 @@
+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?
+          return response.body["data"]["url"]
+        end
+      end
+
+    end
+
+  end
+end

data/lib/paddle/version.rb

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

data/lib/paddle.rb

@@ -39,6 +39,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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paddle
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Dean Perry
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-05 00:00:00.000000000 Z
+date: 2024-04-24 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: []
@@ -83,6 +83,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 +94,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 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
-signing_key:
+rubygems_version: 3.5.9
+signing_key: 
 specification_version: 4
 summary: Ruby library for the Paddle Billing & Classic APIs
 test_files: []