Class: Pago::V2026_04::Services::BenefitGrants

Inherits:
Service
  • Object
show all
Defined in:
lib/pago/v2026_04/services/benefit_grants.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

#list(organization_id: nil, customer_id: nil, external_customer_id: nil, is_granted: nil, page: 1, limit: 10, sorting: ["-created_at"]) ⇒ Models::ListResourceBenefitGrant

List benefit grants across all benefits accessible to the authenticated subject.

Scopes: benefits:read benefits:write

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 customer external ID.

  • is_granted (Boolean, nil) (defaults to: nil) —

    Filter by granted status. If true, only granted benefits will be returned. If false, only revoked benefits will be returned.

  • 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: ["-created_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)
  • is_granted: (Boolean, nil) (defaults to: nil)
  • page: (Integer, nil) (defaults to: 1)
  • limit: (Integer, nil) (defaults to: 10)
  • sorting: (Array[String], nil) (defaults to: ["-created_at"])

Returns:

Raises:



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

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

#list_each(organization_id: nil, customer_id: nil, external_customer_id: nil, is_granted: nil, limit: 10, sorting: ["-created_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)
  • is_granted: (Boolean, nil) (defaults to: nil)
  • limit: (Integer, nil) (defaults to: 10)
  • sorting: (Array[String], nil) (defaults to: ["-created_at"])

Yield Parameters:

Returns:



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

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