Class: GoCardlessPro::Services::BlocksService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/gocardless_pro/services/blocks_service.rb

Overview

Service for making requests to the Block endpoints

Instance Method Summary collapse

Methods inherited from BaseService

#initialize, #make_request, #sub_url

Constructor Details

This class inherits a constructor from GoCardlessPro::Services::BaseService

Instance Method Details

#all(options = {}) ⇒ Object

Get a lazily enumerated list of all the items returned. This is similar to the ‘list` method but will paginate for you automatically.

Otherwise they will be the body of the request.

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash. If the request is a GET, these will be converted to query parameters.



89
90
91
92
93
94
 
# File 'lib/gocardless_pro/services/blocks_service.rb', line 89

def all(options = {})
  Paginator.new(
    service: self,
    options: options
  ).enumerator
end

#block_by_ref(options = {}) ⇒ Object

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

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# 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

#create(options = {}) ⇒ Object

Creates a new Block of a given type. By default it will be active. Example URL: /blocks

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# 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

#disable(identity, options = {}) ⇒ Object

Disables a block so that it no longer will prevent mandate creation. Example URL: /blocks/:identity/actions/disable

Parameters:

  • identity —

    # Unique identifier, beginning with “BLC”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# 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

#enable(identity, options = {}) ⇒ Object

Enables a previously disabled block so that it will prevent mandate creation Example URL: /blocks/:identity/actions/enable

Parameters:

  • identity —

    # Unique identifier, beginning with “BLC”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# 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

#get(identity, options = {}) ⇒ Object

Retrieves the details of an existing block. Example URL: /blocks/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “BLC”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# 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

#list(options = {}) ⇒ Object

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your blocks. Example URL: /blocks

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# 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