class GoCardlessPro::Services::PayoutItemsService
Service for making requests to the PayoutItem endpoints
Public Instance Methods
Source
# File lib/gocardless_pro/services/payout_items_service.rb, line 40 def all(options = {}) Paginator.new( service: self, options: options ).enumerator end
Get a lazily enumerated list of all the items returned. This is similar 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.
Source
# File lib/gocardless_pro/services/payout_items_service.rb, line 22 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
Returns a [cursor-paginated](api-usage-cursor-pagination) list of items in the payout.
<strong>This endpoint only serves requests for payouts created in the last 6 months. Requests for older payouts will return an HTTP status 410 Gone
.</strong>
Example URL: /payout_items @param options [Hash] parameters as a hash, under a params key.
Private Instance Methods
Source
# File lib/gocardless_pro/services/payout_items_service.rb, line 57 def envelope_key 'payout_items' end
return the key which API responses will envelope data under
Source
# File lib/gocardless_pro/services/payout_items_service.rb, line 52 def unenvelope_body(body) body[envelope_key] || body['data'] end
Unenvelope the response of the body using the service’s ‘envelope_key`
@param body [Hash]