class GoCardlessPro::Services::ExportsService
Service for making requests to the Export endpoints
Public Instance Methods
Source
# File lib/gocardless_pro/services/exports_service.rb, line 53 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/exports_service.rb, line 18 def get(identity, options = {}) path = sub_url('/exports/:identity', { 'identity' => identity }) options[:retry_failures] = true response = make_request(:get, path, options) return if response.body.nil? Resources::Export.new(unenvelope_body(response.body), response) end
Returns a single export. Example URL: /exports/:identity
@param identity # Unique identifier, beginning with “EX”. @param options [Hash] parameters as a hash, under a params key.
Source
# File lib/gocardless_pro/services/exports_service.rb, line 35 def list(options = {}) path = '/exports' options[:retry_failures] = true response = make_request(:get, path, options) ListResponse.new( response: response, unenveloped_body: unenvelope_body(response.body), resource_class: Resources::Export ) end
Returns a list of exports which are available for download. Example URL: /exports @param options [Hash] parameters as a hash, under a params key.
Private Instance Methods
Source
# File lib/gocardless_pro/services/exports_service.rb, line 70 def envelope_key 'exports' end
return the key which API responses will envelope data under
Source
# File lib/gocardless_pro/services/exports_service.rb, line 65 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]