Class: AbacatePay::Clients::BillingClient Deprecated

Inherits:
Client
  • Object
show all
Defined in:
lib/abacate_pay/clients/billing_client.rb

Overview

Deprecated.

Use CheckoutClient instead.

Deprecated client for the v1 billing endpoints.

The endpoints this class calls (/billings/create, /billings/list) do not exist on either API version, v2 replaced them with /checkouts/*, and v1 uses the singular /billing/*. Every call raises ApiError.

Kept only so existing code keeps loading; it will be removed in 2.0.0.

Constant Summary collapse

URI =

API endpoint for billing-related operations

"billings"

Constants inherited from Client

Client::RETRIABLE_EXCEPTIONS, Client::RETRIABLE_METHODS, Client::RETRIABLE_STATUSES

Instance Method Summary collapse

Methods inherited from Client

#auto_paging_each, #each_page

Constructor Details

#initialize(client = nil) ⇒ BillingClient

Deprecated.

Use CheckoutClient instead

Returns a new instance of BillingClient.

Parameters:

  • client (Faraday::Connection, nil) (defaults to: nil) —

    Optional Faraday client for custom configurations



20
21
22
23
24
25
 
# File 'lib/abacate_pay/clients/billing_client.rb', line 20

def initialize(client = nil)
  warn "[DEPRECATION] BillingClient calls /billings/* endpoints that do not exist on the " \
       "AbacatePay API, so every request fails. Use AbacatePay.checkouts instead. " \
       "This class will be removed in 2.0.0."
  super(URI, client)
end

Instance Method Details

#create(data) ⇒ Resources::Billing

Creates a new billing

Parameters:

  • data (Resources::Billing) —

    The billing data to be sent for creation

Returns:

  • (Resources::Billing) —

    The created Billing object



39
40
41
42
 
# File 'lib/abacate_pay/clients/billing_client.rb', line 39

def create(data)
  response = request("POST", "create", json: build_create_payload(data))
  Resources::Billings.new(response)
end

#list ⇒ Array<Resources::Billing>

Retrieves a list of billings

Returns:

  • (Array<Resources::Billing>) —

    Array of Billing objects



30
31
32
33
 
# File 'lib/abacate_pay/clients/billing_client.rb', line 30

def list
  response = request("GET", "list")
  build_list(response, Resources::Billings)
end