pago-sdk 1.0.0

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class BenefitGrants < ::Pago::Service
+        # List benefit grants across all benefits accessible to the authenticated subject.
+        #
+        # **Scopes**: `benefits:read` `benefits:write`
+        #
+        # @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 customer external ID.
+        # @param is_granted [Boolean, nil] Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned.
+        # @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::ListResourceBenefitGrant]
+        def list(organization_id: nil, customer_id: nil, external_customer_id: nil, is_granted: nil, page: 1, limit: 10, sorting: ["-created_at"])
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/benefit-grants/",
+            path_params: {},
+            query: { "organization_id" => organization_id, "customer_id" => customer_id, "external_customer_id" => external_customer_id, "is_granted" => is_granted, "page" => page, "limit" => limit, "sorting" => sorting },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceBenefitGrant.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::BenefitGrant]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(organization_id: nil, customer_id: nil, external_customer_id: nil, is_granted: nil, limit: 10, sorting: ["-created_at"], &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(organization_id: organization_id, customer_id: customer_id, external_customer_id: external_customer_id, is_granted: is_granted, page: page_number, limit: limit, sorting: sorting)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Benefits < ::Pago::Service
+        # List benefits.
+        #
+        # **Scopes**: `benefits:read` `benefits:write`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param type [String, Array<String>, nil] Filter by benefit type.
+        # @param id [String, Array<String>, nil] Filter by benefit IDs.
+        # @param exclude_id [String, Array<String>, nil] Exclude benefits with these IDs.
+        # @param query [String, nil] Filter by description.
+        # @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::ListResourceBenefit]
+        def list(organization_id: nil, type: nil, id: nil, exclude_id: nil, query: nil, page: 1, limit: 10, sorting: ["-created_at"], metadata: nil)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/benefits/",
+            path_params: {},
+            query: { "organization_id" => organization_id, "type" => type, "id" => id, "exclude_id" => exclude_id, "query" => query, "page" => page, "limit" => limit, "sorting" => sorting, "metadata" => metadata },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceBenefit.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, type: nil, id: nil, exclude_id: nil, query: nil, limit: 10, sorting: ["-created_at"], metadata: nil, &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(organization_id: organization_id, type: type, id: id, exclude_id: exclude_id, query: query, page: page_number, limit: limit, sorting: sorting, metadata: metadata)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a benefit.
+        #
+        # **Scopes**: `benefits: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 [Object]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/benefits/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Unions::Benefit.from_json(data)
+        end
+
+        # Get a benefit by ID.
+        #
+        # **Scopes**: `benefits:read` `benefits: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 [Object]
+        def get(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/benefits/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Unions::Benefit.from_json(data)
+        end
+
+        # Delete a benefit.
+        #
+        # > [!WARNING]
+        # > Every grants associated with the benefit will be revoked.
+        # > Users will lose access to the benefit.
+        #
+        # **Scopes**: `benefits:write`
+        #
+        # @param id [String]
+        # @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 [nil]
+        def delete(id)
+          client.request(
+            http_method: "DELETE",
+            path: "/v1/benefits/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :none,
+            errors: { 403 => Errors::NotPermitted, 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+        end
+
+        # Update a benefit.
+        #
+        # **Scopes**: `benefits:write`
+        #
+        # @param id [String]
+        # @param body [Hash, Models::BenefitCustomUpdate, Models::BenefitDiscordUpdate, Models::BenefitGitHubRepositoryUpdate, Models::BenefitDownloadablesUpdate, Models::BenefitLicenseKeysUpdate, Models::BenefitMeterCreditUpdate, Models::BenefitFeatureFlagUpdate, Models::BenefitSlackSharedChannelUpdate] 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 [Object]
+        def update(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/benefits/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Unions::Benefit.from_json(data)
+        end
+
+        # List the individual grants for a benefit.
+        #
+        # It's especially useful to check if a user has been granted a benefit.
+        #
+        # **Scopes**: `benefits:read` `benefits:write`
+        #
+        # @param id [String]
+        # @param is_granted [Boolean, nil] Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned.
+        # @param customer_id [String, Array<String>, nil] Filter by customer.
+        # @param member_id [String, Array<String>, nil] Filter by member.
+        # @param page [Integer] Page number, defaults to 1.
+        # @param limit [Integer] Size of a page, defaults to 10. Maximum is 100.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::ListResourceBenefitGrant]
+        def grants(id, is_granted: nil, customer_id: nil, member_id: nil, page: 1, limit: 10)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/benefits/{id}/grants",
+            path_params: { "id" => id },
+            query: { "is_granted" => is_granted, "customer_id" => customer_id, "member_id" => member_id, "page" => page, "limit" => limit },
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceBenefitGrant.from_json(data)
+        end
+
+        # Enumerate every item of `grants`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::BenefitGrant]
+        # @return [Pago::Paginator] when called without a block.
+        def grants_each(id, is_granted: nil, customer_id: nil, member_id: nil, limit: 10, &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            grants(id, is_granted: is_granted, customer_id: customer_id, member_id: member_id, page: page_number, limit: limit)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class CheckoutLinks < ::Pago::Service
+        # List checkout links.
+        #
+        # **Scopes**: `checkout_links:read` `checkout_links:write`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param product_id [String, Array<String>, nil] Filter by product 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::ListResourceCheckoutLink]
+        def list(organization_id: nil, product_id: nil, page: 1, limit: 10, sorting: ["created_at"])
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/checkout-links/",
+            path_params: {},
+            query: { "organization_id" => organization_id, "product_id" => product_id, "page" => page, "limit" => limit, "sorting" => sorting },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceCheckoutLink.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::CheckoutLink]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(organization_id: nil, product_id: nil, limit: 10, sorting: ["created_at"], &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(organization_id: organization_id, product_id: product_id, page: page_number, limit: limit, sorting: sorting)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a checkout link.
+        #
+        # **Scopes**: `checkout_links: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::CheckoutLink]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/checkout-links/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::CheckoutLink.from_json(data)
+        end
+
+        # Get a checkout link by ID.
+        #
+        # **Scopes**: `checkout_links:read` `checkout_links:write`
+        #
+        # @param id [String] The checkout link 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::CheckoutLink]
+        def get(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/checkout-links/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::CheckoutLink.from_json(data)
+        end
+
+        # Delete a checkout link.
+        #
+        # **Scopes**: `checkout_links:write`
+        #
+        # @param id [String] The checkout link ID.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [nil]
+        def delete(id)
+          client.request(
+            http_method: "DELETE",
+            path: "/v1/checkout-links/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :none,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+        end
+
+        # Update a checkout link.
+        #
+        # **Scopes**: `checkout_links:write`
+        #
+        # @param id [String] The checkout link ID.
+        # @param body [Hash, Models::CheckoutLinkUpdate] 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::CheckoutLink]
+        def update(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/checkout-links/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::CheckoutLink.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Checkouts < ::Pago::Service
+        # List checkout sessions.
+        #
+        # **Scopes**: `checkouts:read` `checkouts:write`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param product_id [String, Array<String>, nil] Filter by product 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 status [String, Array<String>, nil] Filter by checkout session status.
+        # @param query [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::ListResourceCheckout]
+        def list(organization_id: nil, product_id: nil, customer_id: nil, external_customer_id: nil, status: nil, query: nil, page: 1, limit: 10, sorting: ["-created_at"])
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/checkouts/",
+            path_params: {},
+            query: { "organization_id" => organization_id, "product_id" => product_id, "customer_id" => customer_id, "external_customer_id" => external_customer_id, "status" => status, "query" => query, "page" => page, "limit" => limit, "sorting" => sorting },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceCheckout.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::Checkout]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(organization_id: nil, product_id: nil, customer_id: nil, external_customer_id: nil, status: nil, query: nil, limit: 10, sorting: ["-created_at"], &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(organization_id: organization_id, product_id: product_id, customer_id: customer_id, external_customer_id: external_customer_id, status: status, query: query, page: page_number, limit: limit, sorting: sorting)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a checkout session.
+        #
+        # **Scopes**: `checkouts:write`
+        #
+        # @param body [Hash, Models::CheckoutCreate] the request body.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Checkout]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/checkouts/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::Checkout.from_json(data)
+        end
+
+        # Get a checkout session by ID.
+        #
+        # **Scopes**: `checkouts:read` `checkouts:write`
+        #
+        # @param id [String] The checkout session 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::Checkout]
+        def get(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/checkouts/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Checkout.from_json(data)
+        end
+
+        # Update a checkout session.
+        #
+        # **Scopes**: `checkouts:write`
+        #
+        # @param id [String] The checkout session ID.
+        # @param body [Hash, Models::CheckoutUpdate] the request body.
+        # @raise [Errors::Update403Error] 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::Checkout]
+        def update(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/checkouts/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 403 => Errors::Update403Error, 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Checkout.from_json(data)
+        end
+
+        # Get a checkout session by client secret.
+        #
+        # @param client_secret [String] The checkout session client secret.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::ExpiredCheckoutError] on HTTP 410.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::CheckoutPublic]
+        def client_get(client_secret)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/checkouts/client/{client_secret}",
+            path_params: { "client_secret" => client_secret },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 410 => Errors::ExpiredCheckoutError, 422 => Errors::HTTPValidationError }
+          )
+          Models::CheckoutPublic.from_json(data)
+        end
+
+        # Update a checkout session by client secret.
+        #
+        # @param client_secret [String] The checkout session client secret.
+        # @param body [Hash, Models::CheckoutUpdatePublic] the request body.
+        # @raise [Errors::ClientUpdate403Error] on HTTP 403.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::ExpiredCheckoutError] on HTTP 410.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::CheckoutPublic]
+        def client_update(client_secret, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/checkouts/client/{client_secret}",
+            path_params: { "client_secret" => client_secret },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 403 => Errors::ClientUpdate403Error, 404 => Errors::ResourceNotFound, 410 => Errors::ExpiredCheckoutError, 422 => Errors::HTTPValidationError }
+          )
+          Models::CheckoutPublic.from_json(data)
+        end
+
+        # Confirm a checkout session by client secret.
+        #
+        # Orders and subscriptions will be processed.
+        #
+        # @param client_secret [String] The checkout session client secret.
+        # @param body [Hash, Models::CheckoutConfirmStripe] the request body.
+        # @raise [Errors::PaymentError] on HTTP 400.
+        # @raise [Errors::ClientConfirm403Error] on HTTP 403.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::ExpiredCheckoutError] on HTTP 410.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::CheckoutPublicConfirmed]
+        def client_confirm(client_secret, body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/checkouts/client/{client_secret}/confirm",
+            path_params: { "client_secret" => client_secret },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 400 => Errors::PaymentError, 403 => Errors::ClientConfirm403Error, 404 => Errors::ResourceNotFound, 410 => Errors::ExpiredCheckoutError, 422 => Errors::HTTPValidationError }
+          )
+          Models::CheckoutPublicConfirmed.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class CustomFields < ::Pago::Service
+        # List custom fields.
+        #
+        # **Scopes**: `custom_fields:read` `custom_fields:write`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param query [String, nil] Filter by custom field name or slug.
+        # @param type [String, Array<String>, nil] Filter by custom field type.
+        # @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::ListResourceCustomField]
+        def list(organization_id: nil, query: nil, type: nil, page: 1, limit: 10, sorting: ["slug"])
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/custom-fields/",
+            path_params: {},
+            query: { "organization_id" => organization_id, "query" => query, "type" => type, "page" => page, "limit" => limit, "sorting" => sorting },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceCustomField.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, query: nil, type: nil, limit: 10, sorting: ["slug"], &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(organization_id: organization_id, query: query, type: type, page: page_number, limit: limit, sorting: sorting)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a custom field.
+        #
+        # **Scopes**: `custom_fields: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 [Object]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/custom-fields/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Unions::CustomField.from_json(data)
+        end
+
+        # Get a custom field by ID.
+        #
+        # **Scopes**: `custom_fields:read` `custom_fields:write`
+        #
+        # @param id [String] The custom field 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/custom-fields/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Unions::CustomField.from_json(data)
+        end
+
+        # Delete a custom field.
+        #
+        # **Scopes**: `custom_fields:write`
+        #
+        # @param id [String] The custom field ID.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [nil]
+        def delete(id)
+          client.request(
+            http_method: "DELETE",
+            path: "/v1/custom-fields/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :none,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+        end
+
+        # Update a custom field.
+        #
+        # **Scopes**: `custom_fields:write`
+        #
+        # @param id [String] The custom field ID.
+        # @param body [Hash, Object] 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 [Object]
+        def update(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/custom-fields/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Unions::CustomField.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end