Class: Pago::V2026_04::Services::Members

Inherits:

Service

• Object
• Service
• Pago::V2026_04::Services::Members

Defined in:

lib/pago/v2026_04/services/members.rb,
sig/pago/v2026_04/generated.rbs

Instance Attribute Summary

Attributes inherited from Service

#client

Instance Method Summary

• #list_members(customer_id: nil, external_customer_id: nil, role: nil, page: 1, limit: 10, sorting: ["-created_at"]) ⇒ Models::ListResourceMember

  List members with optional customer ID filter.

• #list_members_each(customer_id: nil, external_customer_id: nil, role: nil, limit: 10, sorting: ["-created_at"]) {|item| ... } ⇒ Pago::Paginator

  Enumerate every item of list_members, fetching pages on demand.

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from Pago::Service

Instance Method Details

#list_members(customer_id: nil, external_customer_id: nil, role: nil, page: 1, limit: 10, sorting: ["-created_at"]) ⇒ Models::ListResourceMember

List members with optional customer ID filter.

Scopes: members:read members:write

Parameters:

• customer_id (String, nil) (defaults to: nil) —

  Filter by customer ID.

• external_customer_id (String, nil) (defaults to: nil) —

  Filter by customer external ID.

• role (String, nil) (defaults to: nil) —

  Filter by member role.

• 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.

• customer_id: (String, nil) (defaults to: nil)
• external_customer_id: (String, nil) (defaults to: nil)
• role: (String, 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:

• (Models::ListResourceMember)

Raises:

• (Errors::HTTPValidationError) —

  on HTTP 422.

• (Pago::NetworkError) —

  when the request never reached the API.

# File 'lib/pago/v2026_04/services/members.rb', line 20

def list_members(customer_id: nil, external_customer_id: nil, role: nil, page: 1, limit: 10, sorting: ["-created_at"])
  data = client.request(
    http_method: "GET",
    path: "/v1/members/",
    path_params: {},
    query: { "customer_id" => customer_id, "external_customer_id" => external_customer_id, "role" => role, "page" => page, "limit" => limit, "sorting" => sorting },
    response_type: :json,
    errors: { 422 => Errors::HTTPValidationError }
  )
  Models::ListResourceMember.from_json(data)
end

#list_members_each(customer_id: nil, external_customer_id: nil, role: nil, limit: 10, sorting: ["-created_at"]) {|item| ... } ⇒ Pago::Paginator

Enumerate every item of list_members, fetching pages on demand.

Parameters:

• customer_id: (String, nil) (defaults to: nil)
• external_customer_id: (String, nil) (defaults to: nil)
• role: (String, nil) (defaults to: nil)
• limit: (Integer, nil) (defaults to: 10)
• sorting: (Array[String], nil) (defaults to: ["-created_at"])

Yield Parameters:

• item (Models::Member)

Returns:

• (Pago::Paginator) —

  when called without a block.

# File 'lib/pago/v2026_04/services/members.rb', line 36

def list_members_each(customer_id: nil, external_customer_id: nil, role: nil, limit: 10, sorting: ["-created_at"], &block)
  paginator = ::Pago::Paginator.new do |page_number|
    list_members(customer_id: customer_id, external_customer_id: external_customer_id, role: role, page: page_number, limit: limit, sorting: sorting)
  end
  block ? paginator.each(&block) : paginator
end