Class: Pago::V2026_04::Services::CustomerMeters

Inherits:
Service
  • Object
show all
Defined in:
lib/pago/v2026_04/services/customer_meters.rb,
sig/pago/v2026_04/generated.rbs

Instance Attribute Summary

Attributes inherited from Service

#client

Instance Method Summary collapse

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from Pago::Service

Instance Method Details

#get(id) ⇒ Models::CustomerMeter

Get a customer meter by ID.

Scopes: customer_meters:read

Parameters:

  • id (String) —

    The customer meter ID.

Returns:

Raises:



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/pago/v2026_04/services/customer_meters.rb', line 53

def get(id)
  data = client.request(
    http_method: "GET",
    path: "/v1/customer-meters/{id}",
    path_params: { "id" => id },
    query: {},
    response_type: :json,
    errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
  )
  Models::CustomerMeter.from_json(data)
end

#list(organization_id: nil, customer_id: nil, external_customer_id: nil, meter_id: nil, page: 1, limit: 10, sorting: ["-modified_at"]) ⇒ Models::ListResourceCustomerMeter

List customer meters.

Scopes: customer_meters:read

Parameters:

  • organization_id (String, Array<String>, nil) (defaults to: nil) —

    Filter by organization ID.

  • customer_id (String, Array<String>, nil) (defaults to: nil) —

    Filter by customer ID.

  • external_customer_id (String, Array<String>, nil) (defaults to: nil) —

    Filter by external customer ID.

  • meter_id (String, Array<String>, nil) (defaults to: nil) —

    Filter by meter ID.

  • page (Integer) (defaults to: 1) —

    Page number, defaults to 1.

  • limit (Integer) (defaults to: 10) —

    Size of a page, defaults to 10. Maximum is 100.

  • sorting (Array<String>, nil) (defaults to: ["-modified_at"]) —

    Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

  • organization_id: (Object) (defaults to: nil)
  • customer_id: (Object) (defaults to: nil)
  • external_customer_id: (Object) (defaults to: nil)
  • meter_id: (Object) (defaults to: nil)
  • page: (Integer, nil) (defaults to: 1)
  • limit: (Integer, nil) (defaults to: 10)
  • sorting: (Array[String], nil) (defaults to: ["-modified_at"])

Returns:

Raises:



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/pago/v2026_04/services/customer_meters.rb', line 21

def list(organization_id: nil, customer_id: nil, external_customer_id: nil, meter_id: nil, page: 1, limit: 10, sorting: ["-modified_at"])
  data = client.request(
    http_method: "GET",
    path: "/v1/customer-meters/",
    path_params: {},
    query: { "organization_id" => organization_id, "customer_id" => customer_id, "external_customer_id" => external_customer_id, "meter_id" => meter_id, "page" => page, "limit" => limit, "sorting" => sorting },
    response_type: :json,
    errors: { 422 => Errors::HTTPValidationError }
  )
  Models::ListResourceCustomerMeter.from_json(data)
end

#list_each(organization_id: nil, customer_id: nil, external_customer_id: nil, meter_id: nil, limit: 10, sorting: ["-modified_at"]) {|item| ... } ⇒ Pago::Paginator

Enumerate every item of list, fetching pages on demand.

Parameters:

  • organization_id: (Object) (defaults to: nil)
  • customer_id: (Object) (defaults to: nil)
  • external_customer_id: (Object) (defaults to: nil)
  • meter_id: (Object) (defaults to: nil)
  • limit: (Integer, nil) (defaults to: 10)
  • sorting: (Array[String], nil) (defaults to: ["-modified_at"])

Yield Parameters:

Returns:



37
38
39
40
41
42
 
# File 'lib/pago/v2026_04/services/customer_meters.rb', line 37

def list_each(organization_id: nil, customer_id: nil, external_customer_id: nil, meter_id: nil, limit: 10, sorting: ["-modified_at"], &block)
  paginator = ::Pago::Paginator.new do |page_number|
    list(organization_id: organization_id, customer_id: customer_id, external_customer_id: external_customer_id, meter_id: meter_id, page: page_number, limit: limit, sorting: sorting)
  end
  block ? paginator.each(&block) : paginator
end