pago-sdk 1.0.0

data/lib/pago/v2026_04/services/customer_meters.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class CustomerMeters < ::Pago::Service
+        # List customer meters.
+        #
+        # **Scopes**: `customer_meters:read`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param customer_id [String, Array<String>, nil] Filter by customer ID.
+        # @param external_customer_id [String, Array<String>, nil] Filter by external customer ID.
+        # @param meter_id [String, Array<String>, nil] Filter by meter ID.
+        # @param page [Integer] Page number, defaults to 1.
+        # @param limit [Integer] Size of a page, defaults to 10. Maximum is 100.
+        # @param sorting [Array<String>, nil] 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.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::ListResourceCustomerMeter]
+        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
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::CustomerMeter]
+        # @return [Pago::Paginator] when called without a block.
+        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
+
+        # Get a customer meter by ID.
+        #
+        # **Scopes**: `customer_meters:read`
+        #
+        # @param id [String] The customer meter ID.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::CustomerMeter]
+        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
+
+      end
+
+    end
+  end
+end