class GoCardlessPro::Services::BlocksService
Service for making requests to the Block endpoints
Public Instance Methods
Source
# File lib/gocardless_pro/services/blocks_service.rb, line 89 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/blocks_service.rb, line 180 def block_by_ref(options = {}) path = '/blocks/block_by_ref' params = options.delete(:params) || {} options[:params] = {} options[:params]['data'] = params options[:retry_failures] = false begin response = make_request(:post, path, options) # Response doesn't raise any errors until #body is called response.tap(&:body) rescue InvalidStateError => e if e.idempotent_creation_conflict? case @api_service.on_idempotency_conflict when :raise raise IdempotencyConflict, e.error when :fetch return get(e.conflicting_resource_id) end end raise e end ListResponse.new( response: response, unenveloped_body: unenvelope_body(response.body), resource_class: Resources::Block ) end
Creates new blocks for a given reference. By default blocks will be active. Returns 201 if at least one block was created. Returns 200 if there were no new blocks created. Example URL: /blocks/block_by_ref @param options [Hash] parameters as a hash, under a params key.
Source
# File lib/gocardless_pro/services/blocks_service.rb, line 16 def create(options = {}) path = '/blocks' params = options.delete(:params) || {} options[:params] = {} options[:params][envelope_key] = params options[:retry_failures] = true begin response = make_request(:post, path, options) # Response doesn't raise any errors until #body is called response.tap(&:body) rescue InvalidStateError => e if e.idempotent_creation_conflict? case @api_service.on_idempotency_conflict when :raise raise IdempotencyConflict, e.error when :fetch return get(e.conflicting_resource_id) end end raise e end return if response.body.nil? Resources::Block.new(unenvelope_body(response.body), response) end
Creates a new Block of a given type. By default it will be active. Example URL: /blocks @param options [Hash] parameters as a hash, under a params key.
Source
# File lib/gocardless_pro/services/blocks_service.rb, line 101 def disable(identity, options = {}) path = sub_url('/blocks/:identity/actions/disable', { 'identity' => identity }) params = options.delete(:params) || {} options[:params] = {} options[:params]['data'] = params options[:retry_failures] = false begin response = make_request(:post, path, options) # Response doesn't raise any errors until #body is called response.tap(&:body) rescue InvalidStateError => e if e.idempotent_creation_conflict? case @api_service.on_idempotency_conflict when :raise raise IdempotencyConflict, e.error when :fetch return get(e.conflicting_resource_id) end end raise e end return if response.body.nil? Resources::Block.new(unenvelope_body(response.body), response) end
Disables a block so that it no longer will prevent mandate creation. Example URL: /blocks/:identity/actions/disable
@param identity # Unique identifier, beginning with “BLC”. @param options [Hash] parameters as a hash, under a params key.
Source
# File lib/gocardless_pro/services/blocks_service.rb, line 140 def enable(identity, options = {}) path = sub_url('/blocks/:identity/actions/enable', { 'identity' => identity }) params = options.delete(:params) || {} options[:params] = {} options[:params]['data'] = params options[:retry_failures] = false begin response = make_request(:post, path, options) # Response doesn't raise any errors until #body is called response.tap(&:body) rescue InvalidStateError => e if e.idempotent_creation_conflict? case @api_service.on_idempotency_conflict when :raise raise IdempotencyConflict, e.error when :fetch return get(e.conflicting_resource_id) end end raise e end return if response.body.nil? Resources::Block.new(unenvelope_body(response.body), response) end
Enables a previously disabled block so that it will prevent mandate creation Example URL: /blocks/:identity/actions/enable
@param identity # Unique identifier, beginning with “BLC”. @param options [Hash] parameters as a hash, under a params key.
Source
# File lib/gocardless_pro/services/blocks_service.rb, line 53 def get(identity, options = {}) path = sub_url('/blocks/:identity', { 'identity' => identity }) options[:retry_failures] = true response = make_request(:get, path, options) return if response.body.nil? Resources::Block.new(unenvelope_body(response.body), response) end
Retrieves the details of an existing block. Example URL: /blocks/:identity
@param identity # Unique identifier, beginning with “BLC”. @param options [Hash] parameters as a hash, under a params key.
Source
# File lib/gocardless_pro/services/blocks_service.rb, line 71 def list(options = {}) path = '/blocks' options[:retry_failures] = true response = make_request(:get, path, options) ListResponse.new( response: response, unenveloped_body: unenvelope_body(response.body), resource_class: Resources::Block ) end
Returns a [cursor-paginated](api-usage-cursor-pagination) list of your blocks. Example URL: /blocks @param options [Hash] parameters as a hash, under a params key.
Private Instance Methods
Source
# File lib/gocardless_pro/services/blocks_service.rb, line 224 def envelope_key 'blocks' end
return the key which API responses will envelope data under
Source
# File lib/gocardless_pro/services/blocks_service.rb, line 219 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]