billingrails 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59e4d384a706ec067003e90ace439aaf4ff35590636afe6b1f1b6ebc7fe4933e
-  data.tar.gz: d1ab7933b186d46c9df8ba048b2b331e8384ec2f8a08cfa3bd87919946e93fdf
+  metadata.gz: 9799e24f7f9e55633b5d63cf7e8869f4b00ad54d681c3440289945947d53c008
+  data.tar.gz: '00099c78db41d07a60d1c110ac069fcdfb9e90aa6b8cf4e9be9434a4189cd258'
 SHA512:
-  metadata.gz: c4c25b6d11a168d8353d252fce17e083d7643f937f77a7c1322403182e5687e5c99aa7b57d3bf30fd6c7fab877071a7aa7723614368cb153a8c2e93ae1757dc8
-  data.tar.gz: 7f8c10777419884ce6d5c37a83a265c24994da25e4fb4c5bc1d65d3a152fb8e71adc060a44830f844377a3fa1a19db9548c80c226b221d4cd337cef62380e5c9
+  metadata.gz: a642d974337f57e72415f7df51de826e73e0c4e7c8e57f86e60a44522bca38500e1fed97f469cd78365e22ff0c757313a25f43c8c9f3530adfcff3cd482e18fe
+  data.tar.gz: eff17708789b8e6ad2dbf661c106745f40d9321a28175556d0973014a0ab64ed3e39719a800bb16cabd6881a7e8b75da0288b4fea29a7e950d9a6620dd2d1c03

data/lib/billingrails/client.rb

@@ -33,22 +33,21 @@ module Billingrails
 
       # Initialize top-level resources
       @accounts = Resources::Accounts.new(self)
-      @invoices = Resources::Invoices.new(self)
+      @benefits = Resources::Benefits.new(self)
       @charges = Resources::Charges.new(self)
+      @checkout_sessions = Resources::CheckoutSessions.new(self)
+      @credit_assets = Resources::CreditAssets.new(self)
+      @credit_grants = Resources::CreditGrants.new(self)
+      @discounts = Resources::Discounts.new(self)
+      @events = Resources::Events.new(self)
+      @invoices = Resources::Invoices.new(self)
+      @meters = Resources::Meters.new(self)
       @payments = Resources::Payments.new(self)
       @payment_links = Resources::PaymentLinks.new(self)
-      @checkout_sessions = Resources::CheckoutSessions.new(self)
-
-      @products = Resources::Products.new(self)
-      @prices = Resources::Prices.new(self)
       @plans = Resources::Plans.new(self)
+      @prices = Resources::Prices.new(self)
+      @products = Resources::Products.new(self)
       @subscriptions = Resources::Subscriptions.new(self)
-      @meters = Resources::Meters.new(self)
-      @events = Resources::Events.new(self)
-
-      @credit_grants = Resources::CreditGrants.new(self)
-      @credit_assets = Resources::CreditAssets.new(self)
-      @discounts = Resources::Discounts.new(self)
       @tax_rates = Resources::TaxRates.new(self)
     end
 

data/lib/billingrails/resources/accounts.rb

@@ -59,7 +59,7 @@ module Billingrails
 
       # Get balances
       #
-      # Retrieve credit balances for an account.
+      # Retrieves credit balances for an account.
       #
       # @param id [String] Resource ID
       # @param params [Hash, nil] Query parameters
@@ -77,10 +77,22 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def debit_balance(id, data)
-        path = "/accounts/#{id}/debit_balance"
+        path = "/accounts/#{id}/debit-balance"
         @client.request(:post, path, body: data)
       end
 
+      # Get entitlements
+      #
+      # Retrieves entitlements for an account grouped by benefit code.
+      #
+      # @param id [String] Resource ID
+      # @param params [Hash, nil] Query parameters
+      # @return [Hash] Response data
+      def get_entitlements(id, params: nil)
+        path = "/accounts/#{id}/entitlements"
+        @client.request(:get, path, params: params)
+      end
+
     end
   end
 end

data/lib/billingrails/resources/benefits.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# This file is auto-generated. Do not edit manually.
+
+module Billingrails
+  module Resources
+    # Benefits resource
+    class Benefits
+      # @param client [Client] The API client
+      def initialize(client)
+        @client = client
+      end
+
+      # List benefits
+      #
+      # Retrieves a list of benefits.
+      #
+      # @param params [Hash, nil] Query parameters
+      # @return [Hash] Response data
+      def list(params: nil)
+        path = "/benefits"
+        @client.request(:get, path, params: params)
+      end
+
+      # Create a benefit
+      #
+      # Creates a benefit.
+      #
+      # @param data [Hash] Request body
+      # @return [Hash] Response data
+      def create(data)
+        path = "/benefits"
+        @client.request(:post, path, body: data)
+      end
+
+      # Retrieve a benefit
+      #
+      # Retrieves a benefit by ID.
+      #
+      # @param id [String] Resource ID
+      # @param params [Hash, nil] Query parameters
+      # @return [Hash] Response data
+      def retrieve(id, params: nil)
+        path = "/benefits/#{id}"
+        @client.request(:get, path, params: params)
+      end
+
+      # Update a benefit
+      #
+      # Updates a benefit.
+      #
+      # @param id [String] Resource ID
+      # @param data [Hash] Request body
+      # @return [Hash] Response data
+      def update(id, data)
+        path = "/benefits/#{id}"
+        @client.request(:patch, path, body: data)
+      end
+
+      # Delete a benefit
+      #
+      # Deletes a benefit by ID. Allowed only when the benefit is not assigned to any product, price or entitlements.
+      #
+      # @param id [String] Resource ID
+      # @return [Hash] Response data
+      def delete(id)
+        path = "/benefits/#{id}"
+        @client.request(:delete, path)
+      end
+
+      # Archive a benefit
+      #
+      # Archives a benefit.
+      #
+      # @param id [String] Resource ID
+      # @return [Hash] Response data
+      def archive(id)
+        path = "/benefits/#{id}/archive"
+        @client.request(:post, path)
+      end
+
+      # Unarchive a benefit
+      #
+      # Unarchives a benefit.
+      #
+      # @param id [String] Resource ID
+      # @return [Hash] Response data
+      def unarchive(id)
+        path = "/benefits/#{id}/unarchive"
+        @client.request(:post, path)
+      end
+
+    end
+  end
+end

data/lib/billingrails/resources/checkout_sessions.rb

@@ -18,7 +18,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def create(data)
-        path = "/checkout_sessions"
+        path = "/checkout-sessions"
         @client.request(:post, path, body: data)
       end
 
@@ -30,7 +30,7 @@ module Billingrails
       # @param params [Hash, nil] Query parameters
       # @return [Hash] Response data
       def retrieve(id, params: nil)
-        path = "/checkout_sessions/#{id}"
+        path = "/checkout-sessions/#{id}"
         @client.request(:get, path, params: params)
       end
 
@@ -42,7 +42,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def update(id, data)
-        path = "/checkout_sessions/#{id}"
+        path = "/checkout-sessions/#{id}"
         @client.request(:patch, path, body: data)
       end
 

data/lib/billingrails/resources/credit_assets.rb

@@ -18,7 +18,7 @@ module Billingrails
       # @param params [Hash, nil] Query parameters
       # @return [Hash] Response data
       def list(params: nil)
-        path = "/credit_assets"
+        path = "/credit-assets"
         @client.request(:get, path, params: params)
       end
 
@@ -29,7 +29,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def create(data)
-        path = "/credit_assets"
+        path = "/credit-assets"
         @client.request(:post, path, body: data)
       end
 
@@ -41,7 +41,7 @@ module Billingrails
       # @param params [Hash, nil] Query parameters
       # @return [Hash] Response data
       def retrieve(id, params: nil)
-        path = "/credit_assets/#{id}"
+        path = "/credit-assets/#{id}"
         @client.request(:get, path, params: params)
       end
 
@@ -53,7 +53,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def update(id, data)
-        path = "/credit_assets/#{id}"
+        path = "/credit-assets/#{id}"
         @client.request(:patch, path, body: data)
       end
 

data/lib/billingrails/resources/credit_grants.rb

@@ -17,7 +17,7 @@ module Billingrails
       #
       # @return [Hash] Response data
       def list()
-        path = "/credit_grants"
+        path = "/credit-grants"
         @client.request(:get, path)
       end
 
@@ -28,7 +28,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def create(data)
-        path = "/credit_grants"
+        path = "/credit-grants"
         @client.request(:post, path, body: data)
       end
 
@@ -40,7 +40,7 @@ module Billingrails
       # @param params [Hash, nil] Query parameters
       # @return [Hash] Response data
       def retrieve(id, params: nil)
-        path = "/credit_grants/#{id}"
+        path = "/credit-grants/#{id}"
         @client.request(:get, path, params: params)
       end
 
@@ -52,7 +52,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def apply(id, data)
-        path = "/credit_grants/#{id}/apply"
+        path = "/credit-grants/#{id}/apply"
         @client.request(:post, path, body: data)
       end
 
@@ -63,7 +63,7 @@ module Billingrails
       # @param id [String] Resource ID
       # @return [Hash] Response data
       def expire(id)
-        path = "/credit_grants/#{id}/expire"
+        path = "/credit-grants/#{id}/expire"
         @client.request(:post, path)
       end
 
@@ -74,7 +74,7 @@ module Billingrails
       # @param id [String] Resource ID
       # @return [Hash] Response data
       def void(id)
-        path = "/credit_grants/#{id}/void"
+        path = "/credit-grants/#{id}/void"
         @client.request(:post, path)
       end
 
@@ -86,7 +86,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def reverse_transaction(id, data)
-        path = "/credit_grants/#{id}/reverse_transaction"
+        path = "/credit-grants/#{id}/reverse-transaction"
         @client.request(:post, path, body: data)
       end
 

data/lib/billingrails/resources/meters.rb

@@ -59,7 +59,7 @@ module Billingrails
 
       # Delete a meter
       #
-      # Deletes a meter when no subscription uses a price associated with it.
+      # Deletes a meter. Allowed only when no price, benefit or subscription is associated with it.
       #
       # @param id [String] Resource ID
       # @return [Hash] Response data

data/lib/billingrails/resources/payment_links.rb

@@ -18,7 +18,7 @@ module Billingrails
       # @param params [Hash, nil] Query parameters
       # @return [Hash] Response data
       def list(params: nil)
-        path = "/payment_links"
+        path = "/payment-links"
         @client.request(:get, path, params: params)
       end
 
@@ -29,7 +29,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def create(data)
-        path = "/payment_links"
+        path = "/payment-links"
         @client.request(:post, path, body: data)
       end
 
@@ -41,7 +41,7 @@ module Billingrails
       # @param params [Hash, nil] Query parameters
       # @return [Hash] Response data
       def retrieve(id, params: nil)
-        path = "/payment_links/#{id}"
+        path = "/payment-links/#{id}"
         @client.request(:get, path, params: params)
       end
 
@@ -53,7 +53,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def update(id, data)
-        path = "/payment_links/#{id}"
+        path = "/payment-links/#{id}"
         @client.request(:patch, path, body: data)
       end
 

data/lib/billingrails/resources/plans.rb

@@ -59,7 +59,7 @@ module Billingrails
 
       # Delete a plan
       #
-      # Deletes a plan.
+      # Deletes a plan. Allowed only when the plan has not been used in any subscription.
       #
       # @param id [String] Resource ID
       # @return [Hash] Response data

data/lib/billingrails/resources/prices.rb

@@ -59,7 +59,7 @@ module Billingrails
 
       # Delete a price
       #
-      # Deletes a price by ID.
+      # Deletes a price. Allowed only when it is not used in any subscription or invoices.
       #
       # @param id [String] Resource ID
       # @return [Hash] Response data

data/lib/billingrails/resources/products.rb

@@ -59,7 +59,7 @@ module Billingrails
 
       # Delete a product
       #
-      # Deletes a product when it is not used in any subscription and not referenced on invoices.
+      # Deletes a product. Allowed only when it is not used in any subscription or invoices.
       #
       # @param id [String] Resource ID
       # @return [Hash] Response data

data/lib/billingrails/resources/subscriptions.rb

@@ -57,9 +57,33 @@ module Billingrails
         @client.request(:patch, path, body: data)
       end
 
+      # Cancel a subscription
+      #
+      # Cancels an active subscription.
+      #
+      # @param id [String] Resource ID
+      # @param data [Hash] Request body
+      # @return [Hash] Response data
+      def cancel(id, data)
+        path = "/subscriptions/#{id}/cancel"
+        @client.request(:post, path, body: data)
+      end
+
+      # Get entitlements
+      #
+      # Retrieves entitlements for a subscription grouped by benefit code.
+      #
+      # @param id [String] Resource ID
+      # @param params [Hash, nil] Query parameters
+      # @return [Hash] Response data
+      def get_entitlements(id, params: nil)
+        path = "/subscriptions/#{id}/entitlements"
+        @client.request(:get, path, params: params)
+      end
+
       # Resume a paused subscription
       #
-      # Creates a subscription resumption checkout session, triggers payment, and returns the payment link. The subscription must be paused. Requires an active payment integration (site payment routes or an active integration). The customer is redirected to the payment link to pay the resumption invoice; after payment the subscription becomes active again.
+      # Creates a subscription resumption checkout session, triggers payment, and returns the payment link. The subscription must be paused. Requires an active payment integration (biller payment routes or an active integration). The customer is redirected to the payment link to pay the resumption invoice; after payment the subscription becomes active again.
       #
       # @param id [String] Resource ID
       # @param data [Hash] Request body

data/lib/billingrails/resources/tax_rates.rb

@@ -18,7 +18,7 @@ module Billingrails
       # @param params [Hash, nil] Query parameters
       # @return [Hash] Response data
       def list(params: nil)
-        path = "/tax_rates"
+        path = "/tax-rates"
         @client.request(:get, path, params: params)
       end
 
@@ -29,7 +29,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def create(data)
-        path = "/tax_rates"
+        path = "/tax-rates"
         @client.request(:post, path, body: data)
       end
 
@@ -41,7 +41,7 @@ module Billingrails
       # @param params [Hash, nil] Query parameters
       # @return [Hash] Response data
       def retrieve(id, params: nil)
-        path = "/tax_rates/#{id}"
+        path = "/tax-rates/#{id}"
         @client.request(:get, path, params: params)
       end
 
@@ -53,7 +53,7 @@ module Billingrails
       # @param data [Hash] Request body
       # @return [Hash] Response data
       def update(id, data)
-        path = "/tax_rates/#{id}"
+        path = "/tax-rates/#{id}"
         @client.request(:patch, path, body: data)
       end
 
@@ -64,7 +64,7 @@ module Billingrails
       # @param id [String] Resource ID
       # @return [Hash] Response data
       def delete(id)
-        path = "/tax_rates/#{id}"
+        path = "/tax-rates/#{id}"
         @client.request(:delete, path)
       end
 
@@ -75,7 +75,7 @@ module Billingrails
       # @param id [String] Resource ID
       # @return [Hash] Response data
       def archive(id)
-        path = "/tax_rates/#{id}/archive"
+        path = "/tax-rates/#{id}/archive"
         @client.request(:post, path)
       end
 
@@ -86,7 +86,7 @@ module Billingrails
       # @param id [String] Resource ID
       # @return [Hash] Response data
       def unarchive(id)
-        path = "/tax_rates/#{id}/unarchive"
+        path = "/tax-rates/#{id}/unarchive"
         @client.request(:post, path)
       end
 

data/lib/billingrails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Billingrails
-  VERSION = '0.2.0'
+  VERSION = '0.2.2'
 end

data/lib/billingrails.rb

@@ -5,6 +5,7 @@ require_relative 'billingrails/errors'
 require_relative 'billingrails/client'
 
 require_relative 'billingrails/resources/accounts'
+require_relative 'billingrails/resources/benefits'
 require_relative 'billingrails/resources/charges'
 require_relative 'billingrails/resources/credit_assets'
 require_relative 'billingrails/resources/checkout_sessions'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: billingrails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Billingrails
@@ -80,6 +80,7 @@ files:
 - lib/billingrails/client.rb
 - lib/billingrails/errors.rb
 - lib/billingrails/resources/accounts.rb
+- lib/billingrails/resources/benefits.rb
 - lib/billingrails/resources/charges.rb
 - lib/billingrails/resources/checkout_sessions.rb
 - lib/billingrails/resources/credit_assets.rb