Class: Pago::V2026_04::Services::CustomerPortal::Downloadables

Inherits:

Service

• Object
• Service
• Pago::V2026_04::Services::CustomerPortal::Downloadables

Defined in:

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

Instance Attribute Summary

Attributes inherited from Service

#client

Instance Method Summary

• #list(benefit_id: nil, page: 1, limit: 10) ⇒ Models::ListResourceDownloadableRead

  Scopes: customer_portal:read customer_portal:write.

• #list_each(benefit_id: nil, limit: 10) {|item| ... } ⇒ Pago::Paginator

  Enumerate every item of list, fetching pages on demand.

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from Pago::Service

Instance Method Details

#list(benefit_id: nil, page: 1, limit: 10) ⇒ Models::ListResourceDownloadableRead

Scopes: customer_portal:read customer_portal:write

Parameters:

• benefit_id (String, Array<String>, nil) (defaults to: nil) —

  Filter by benefit ID.

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

• benefit_id: (Object) (defaults to: nil)
• page: (Integer, nil) (defaults to: 1)
• limit: (Integer, nil) (defaults to: 10)

Returns:

• (Models::ListResourceDownloadableRead)

Raises:

• (Errors::HTTPValidationError) —

  on HTTP 422.

• (Pago::NetworkError) —

  when the request never reached the API.

# File 'lib/pago/v2026_04/services/customer_portal.rb', line 542

def list(benefit_id: nil, page: 1, limit: 10)
  data = client.request(
    http_method: "GET",
    path: "/v1/customer-portal/downloadables/",
    path_params: {},
    query: { "benefit_id" => benefit_id, "page" => page, "limit" => limit },
    response_type: :json,
    errors: { 422 => Errors::HTTPValidationError }
  )
  Models::ListResourceDownloadableRead.from_json(data)
end

#list_each(benefit_id: nil, limit: 10) {|item| ... } ⇒ Pago::Paginator

Enumerate every item of list, fetching pages on demand.

Parameters:

• benefit_id: (Object) (defaults to: nil)
• limit: (Integer, nil) (defaults to: 10)

Yield Parameters:

• item (Models::DownloadableRead)

Returns:

• (Pago::Paginator) —

  when called without a block.

# File 'lib/pago/v2026_04/services/customer_portal.rb', line 558

def list_each(benefit_id: nil, limit: 10, &block)
  paginator = ::Pago::Paginator.new do |page_number|
    list(benefit_id: benefit_id, page: page_number, limit: limit)
  end
  block ? paginator.each(&block) : paginator
end