pago-sdk 1.0.0

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

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Orders < ::Pago::Service
+        # List orders.
+        #
+        # **Scopes**: `orders:read`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param product_id [String, Array<String>, nil] Filter by product ID.
+        # @param product_billing_type [String, Array<String>, nil] Filter by product billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
+        # @param discount_id [String, Array<String>, nil] Filter by discount ID.
+        # @param customer_id [String, Array<String>, nil] Filter by customer ID.
+        # @param external_customer_id [String, Array<String>, nil] Filter by customer external ID.
+        # @param checkout_id [String, Array<String>, nil] Filter by checkout ID.
+        # @param subscription_id [String, Array<String>, nil] Filter by subscription 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.
+        # @param metadata [Object] Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::ListResourceOrder]
+        def list(organization_id: nil, product_id: nil, product_billing_type: nil, discount_id: nil, customer_id: nil, external_customer_id: nil, checkout_id: nil, subscription_id: nil, page: 1, limit: 10, sorting: ["-created_at"], metadata: nil)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/orders/",
+            path_params: {},
+            query: { "organization_id" => organization_id, "product_id" => product_id, "product_billing_type" => product_billing_type, "discount_id" => discount_id, "customer_id" => customer_id, "external_customer_id" => external_customer_id, "checkout_id" => checkout_id, "subscription_id" => subscription_id, "page" => page, "limit" => limit, "sorting" => sorting, "metadata" => metadata },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceOrder.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::Order]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(organization_id: nil, product_id: nil, product_billing_type: nil, discount_id: nil, customer_id: nil, external_customer_id: nil, checkout_id: nil, subscription_id: nil, limit: 10, sorting: ["-created_at"], metadata: nil, &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(organization_id: organization_id, product_id: product_id, product_billing_type: product_billing_type, discount_id: discount_id, customer_id: customer_id, external_customer_id: external_customer_id, checkout_id: checkout_id, subscription_id: subscription_id, page: page_number, limit: limit, sorting: sorting, metadata: metadata)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a draft order for an off-session charge against a saved payment
+        # method. The order is created with `status=draft` and no invoice number;
+        # call `POST /v1/orders/{id}/finalize` to attempt the charge.
+        #
+        # The organization must have the `off_session_charges_enabled` feature flag.
+        #
+        # **Scopes**: `orders:write`
+        #
+        # @param body [Hash, Models::OrderCreate] the request body.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Order]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/orders/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::Order.from_json(data)
+        end
+
+        # Export orders as a CSV file.
+        #
+        # **Scopes**: `orders:read`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param product_id [String, Array<String>, nil] Filter by product ID.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [String]
+        def export(organization_id: nil, product_id: nil)
+          client.request(
+            http_method: "GET",
+            path: "/v1/orders/export",
+            path_params: {},
+            query: { "organization_id" => organization_id, "product_id" => product_id },
+            response_type: :text,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+        end
+
+        # Get an order by ID.
+        #
+        # **Scopes**: `orders:read`
+        #
+        # @param id [String] The order 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::Order]
+        def get(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/orders/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Order.from_json(data)
+        end
+
+        # Update an order.
+        #
+        # **Scopes**: `orders:write`
+        #
+        # @param id [String] The order ID.
+        # @param body [Hash, Models::OrderUpdate] the request body.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Order]
+        def update(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/orders/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Order.from_json(data)
+        end
+
+        # Finalize a draft order and synchronously attempt an off-session charge.
+        #
+        # On success, the order transitions to `paid` and benefit grants fire
+        # before the response returns. On failure (decline, missing payment method,
+        # SCA challenge), the order stays in `draft` and a 4xx error is returned.
+        #
+        # The request fails with 412 if the order is not in `draft` status.
+        #
+        # **Scopes**: `orders:write`
+        #
+        # @param id [String] The order ID.
+        # @param body [Hash, Models::OrderFinalize] the request body.
+        # @raise [Errors::Finalize402Error] on HTTP 402.
+        # @raise [Errors::Finalize403Error] on HTTP 403.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::OrderNotDraft] on HTTP 412.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Order]
+        def finalize(id, body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/orders/{id}/finalize",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 402 => Errors::Finalize402Error, 403 => Errors::Finalize403Error, 404 => Errors::ResourceNotFound, 412 => Errors::OrderNotDraft, 422 => Errors::HTTPValidationError }
+          )
+          Models::Order.from_json(data)
+        end
+
+        # Get an order's invoice data.
+        #
+        # **Scopes**: `orders:read`
+        #
+        # @param id [String] The order 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::OrderInvoice]
+        def invoice(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/orders/{id}/invoice",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::OrderInvoice.from_json(data)
+        end
+
+        # Trigger generation of an order's invoice.
+        #
+        # **Scopes**: `orders:read`
+        #
+        # @param id [String] The order ID.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::OrderNotEligibleForInvoice] on HTTP 409.
+        # @raise [Errors::MissingInvoiceBillingDetails] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Object]
+        def generate_invoice(id)
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/orders/{id}/invoice",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 409 => Errors::OrderNotEligibleForInvoice, 422 => Errors::MissingInvoiceBillingDetails }
+          )
+          data
+        end
+
+        # Get a presigned URL to download an order's receipt PDF.
+        #
+        # **Scopes**: `orders:read`
+        #
+        # @param id [String] The order 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::OrderReceipt]
+        def receipt(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/orders/{id}/receipt",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::OrderReceipt.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Organizations < ::Pago::Service
+        # List organizations.
+        #
+        # **Scopes**: `organizations:read` `organizations:write`
+        #
+        # @param slug [String, nil] Filter by slug.
+        # @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::ListResourceOrganization]
+        def list(slug: nil, page: 1, limit: 10, sorting: ["created_at"])
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/organizations/",
+            path_params: {},
+            query: { "slug" => slug, "page" => page, "limit" => limit, "sorting" => sorting },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceOrganization.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::Organization]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(slug: nil, limit: 10, sorting: ["created_at"], &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(slug: slug, page: page_number, limit: limit, sorting: sorting)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create an organization.
+        #
+        # **Scopes**: `organizations:write`
+        #
+        # @param body [Hash, Models::OrganizationCreate] the request body.
+        # @raise [Errors::CannotCreateOrganizationError] on HTTP 403.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Organization]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/organizations/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 403 => Errors::CannotCreateOrganizationError, 422 => Errors::HTTPValidationError }
+          )
+          Models::Organization.from_json(data)
+        end
+
+        # Get an organization by ID.
+        #
+        # **Scopes**: `organizations:read` `organizations:write`
+        #
+        # @param id [String]
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Organization]
+        def get(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/organizations/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Organization.from_json(data)
+        end
+
+        # Update an organization.
+        #
+        # **Scopes**: `organizations:write`
+        #
+        # @param id [String]
+        # @param body [Hash, Models::OrganizationUpdate] the request body.
+        # @raise [Errors::NotPermitted] on HTTP 403.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::SSOEnforcementRequiresConnection] on HTTP 409.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Organization]
+        def update(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/organizations/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 403 => Errors::NotPermitted, 404 => Errors::ResourceNotFound, 409 => Errors::SSOEnforcementRequiresConnection, 422 => Errors::HTTPValidationError }
+          )
+          Models::Organization.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Payments < ::Pago::Service
+        # List payments.
+        #
+        # **Scopes**: `payments:read`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param checkout_id [String, Array<String>, nil] Filter by checkout ID.
+        # @param order_id [String, Array<String>, nil] Filter by order ID.
+        # @param customer_id [String, Array<String>, nil] Filter by customer ID.
+        # @param status [String, Array<String>, nil] Filter by payment status.
+        # @param method [String, Array<String>, nil] Filter by payment method.
+        # @param customer_email [String, Array<String>, nil] Filter by customer email.
+        # @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::ListResourcePayment]
+        def list(organization_id: nil, checkout_id: nil, order_id: nil, customer_id: nil, status: nil, method: nil, customer_email: nil, page: 1, limit: 10, sorting: ["-created_at"])
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/payments/",
+            path_params: {},
+            query: { "organization_id" => organization_id, "checkout_id" => checkout_id, "order_id" => order_id, "customer_id" => customer_id, "status" => status, "method" => method, "customer_email" => customer_email, "page" => page, "limit" => limit, "sorting" => sorting },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourcePayment.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Object]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(organization_id: nil, checkout_id: nil, order_id: nil, customer_id: nil, status: nil, method: nil, customer_email: nil, limit: 10, sorting: ["-created_at"], &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(organization_id: organization_id, checkout_id: checkout_id, order_id: order_id, customer_id: customer_id, status: status, method: method, customer_email: customer_email, page: page_number, limit: limit, sorting: sorting)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Get a payment by ID.
+        #
+        # **Scopes**: `payments:read`
+        #
+        # @param id [String] The payment ID.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Object]
+        def get(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/payments/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Unions::Payment.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Products < ::Pago::Service
+        # List products.
+        #
+        # **Scopes**: `products:read` `products:write`
+        #
+        # @param id [String, Array<String>, nil] Filter by product ID.
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param query [String, nil] Filter by product name.
+        # @param is_archived [Boolean, nil] Filter on archived products.
+        # @param is_recurring [Boolean, nil] Filter on recurring products. If `true`, only subscriptions tiers are returned. If `false`, only one-time purchase products are returned.
+        # @param benefit_id [String, Array<String>, nil] Filter products granting specific benefit.
+        # @param visibility [Array<String>, nil] Filter by visibility.
+        # @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.
+        # @param metadata [Object] Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::ListResourceProduct]
+        def list(id: nil, organization_id: nil, query: nil, is_archived: nil, is_recurring: nil, benefit_id: nil, visibility: nil, page: 1, limit: 10, sorting: ["-created_at"], metadata: nil)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/products/",
+            path_params: {},
+            query: { "id" => id, "organization_id" => organization_id, "query" => query, "is_archived" => is_archived, "is_recurring" => is_recurring, "benefit_id" => benefit_id, "visibility" => visibility, "page" => page, "limit" => limit, "sorting" => sorting, "metadata" => metadata },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceProduct.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::Product]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(id: nil, organization_id: nil, query: nil, is_archived: nil, is_recurring: nil, benefit_id: nil, visibility: nil, limit: 10, sorting: ["-created_at"], metadata: nil, &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(id: id, organization_id: organization_id, query: query, is_archived: is_archived, is_recurring: is_recurring, benefit_id: benefit_id, visibility: visibility, page: page_number, limit: limit, sorting: sorting, metadata: metadata)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a product.
+        #
+        # **Scopes**: `products:write`
+        #
+        # @param body [Hash, Object] the request body.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Product]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/products/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::Product.from_json(data)
+        end
+
+        # Get a product by ID.
+        #
+        # **Scopes**: `products:read` `products:write`
+        #
+        # @param id [String]
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Product]
+        def get(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/products/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Product.from_json(data)
+        end
+
+        # Update a product.
+        #
+        # **Scopes**: `products:write`
+        #
+        # @param id [String]
+        # @param body [Hash, Models::ProductUpdate] the request body.
+        # @raise [Errors::NotPermitted] on HTTP 403.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Product]
+        def update(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/products/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 403 => Errors::NotPermitted, 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Product.from_json(data)
+        end
+
+        # Update benefits granted by a product.
+        #
+        # **Scopes**: `products:write`
+        #
+        # @param id [String]
+        # @param body [Hash, Models::ProductBenefitsUpdate] the request body.
+        # @raise [Errors::NotPermitted] on HTTP 403.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Product]
+        def update_benefits(id, body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/products/{id}/benefits",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 403 => Errors::NotPermitted, 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Product.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Refunds < ::Pago::Service
+        # List refunds.
+        #
+        # **Scopes**: `refunds:read` `refunds:write`
+        #
+        # @param id [String, Array<String>, nil] Filter by refund ID.
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param order_id [String, Array<String>, nil] Filter by order ID.
+        # @param subscription_id [String, Array<String>, nil] Filter by subscription ID.
+        # @param customer_id [String, Array<String>, nil] Filter by customer ID.
+        # @param external_customer_id [String, Array<String>, nil] Filter by customer external ID.
+        # @param succeeded [Boolean, nil] Filter by `succeeded`.
+        # @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::ListResourceRefund]
+        def list(id: nil, organization_id: nil, order_id: nil, subscription_id: nil, customer_id: nil, external_customer_id: nil, succeeded: nil, page: 1, limit: 10, sorting: ["-created_at"])
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/refunds/",
+            path_params: {},
+            query: { "id" => id, "organization_id" => organization_id, "order_id" => order_id, "subscription_id" => subscription_id, "customer_id" => customer_id, "external_customer_id" => external_customer_id, "succeeded" => succeeded, "page" => page, "limit" => limit, "sorting" => sorting },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceRefund.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::Refund]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(id: nil, organization_id: nil, order_id: nil, subscription_id: nil, customer_id: nil, external_customer_id: nil, succeeded: nil, limit: 10, sorting: ["-created_at"], &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(id: id, organization_id: organization_id, order_id: order_id, subscription_id: subscription_id, customer_id: customer_id, external_customer_id: external_customer_id, succeeded: succeeded, page: page_number, limit: limit, sorting: sorting)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a refund.
+        #
+        # **Scopes**: `refunds:write`
+        #
+        # @param body [Hash, Models::RefundCreate] the request body.
+        # @raise [Errors::RefundedAlready] on HTTP 403.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Refund]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/refunds/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 403 => Errors::RefundedAlready, 422 => Errors::HTTPValidationError }
+          )
+          Models::Refund.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end