class GoCardlessPro::Services::PayoutItemsService
Service for making requests to the PayoutItem endpoints
Public Instance Methods
all(options = {})
click to toggle source
Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
@param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters. Otherwise they will be the body of the request.
# File lib/gocardless_pro/services/payout_items_service.rb, line 36 def all(options = {}) Paginator.new( service: self, options: options ).enumerator end
list(options = {})
click to toggle source
Returns a [cursor-paginated](api-usage-cursor-pagination) list of items in the payout.
Example URL: /payout_items @param options [Hash] parameters as a hash, under a params key.
# File lib/gocardless_pro/services/payout_items_service.rb, line 18 def list(options = {}) path = '/payout_items' options[:retry_failures] = true response = make_request(:get, path, options) ListResponse.new( response: response, unenveloped_body: unenvelope_body(response.body), resource_class: Resources::PayoutItem ) end
Private Instance Methods
envelope_key()
click to toggle source
return the key which API responses will envelope data under
# File lib/gocardless_pro/services/payout_items_service.rb, line 53 def envelope_key 'payout_items' end
unenvelope_body(body)
click to toggle source
Unenvelope the response of the body using the service's `envelope_key`
@param body [Hash]
# File lib/gocardless_pro/services/payout_items_service.rb, line 48 def unenvelope_body(body) body[envelope_key] || body['data'] end