Class: Increase::Resources::IntrafiExclusions

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/intrafi_exclusions.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ IntrafiExclusions

Returns a new instance of IntrafiExclusions.



6
7
8
 
# File 'lib/increase/resources/intrafi_exclusions.rb', line 6

def initialize(client:)
  @client = client
end

Instance Method Details

#archive(intrafi_exclusion_id, opts = {}) ⇒ Increase::Models::IntrafiExclusion

Archive an IntraFi Exclusion

Parameters:

  • intrafi_exclusion_id (String) —

    The identifier of the IntraFi Exclusion request to archive. It may take 5 business days for an exclusion removal to be processed. Removing an exclusion does not guarantee that funds will be swept to the previously-excluded bank.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



75
76
77
78
79
80
81
 
# File 'lib/increase/resources/intrafi_exclusions.rb', line 75

def archive(intrafi_exclusion_id, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/intrafi_exclusions/#{intrafi_exclusion_id}/archive"
  req[:model] = Increase::Models::IntrafiExclusion
  @client.request(req, opts)
end

#create(params = {}, opts = {}) ⇒ Increase::Models::IntrafiExclusion

Create an IntraFi Exclusion

Parameters:

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

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :bank_name (String) —

    The name of the financial institution to be excluded.

  • :entity_id (String) —

    The identifier of the Entity whose deposits will be excluded.

Returns:



19
20
21
22
23
24
25
26
 
# File 'lib/increase/resources/intrafi_exclusions.rb', line 19

def create(params = {}, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/intrafi_exclusions"
  req[:body] = params
  req[:model] = Increase::Models::IntrafiExclusion
  @client.request(req, opts)
end

#list(params = {}, opts = {}) ⇒ Increase::Page<Increase::Models::IntrafiExclusion>

List IntraFi Exclusions.

Parameters:

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

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :cursor (String) —

    Return the page of entries after this one.

  • :entity_id (String) —

    Filter IntraFi Exclusions for those belonging to the specified Entity.

  • :idempotency_key (String) —

    Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

  • :limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Returns:



57
58
59
60
61
62
63
64
65
 
# File 'lib/increase/resources/intrafi_exclusions.rb', line 57

def list(params = {}, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/intrafi_exclusions"
  req[:query] = params
  req[:page] = Increase::Page
  req[:model] = Increase::Models::IntrafiExclusion
  @client.request(req, opts)
end

#retrieve(intrafi_exclusion_id, opts = {}) ⇒ Increase::Models::IntrafiExclusion

Get an IntraFi Exclusion

Parameters:

  • intrafi_exclusion_id (String) —

    The identifier of the IntraFi Exclusion to retrieve.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



34
35
36
37
38
39
40
 
# File 'lib/increase/resources/intrafi_exclusions.rb', line 34

def retrieve(intrafi_exclusion_id, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/intrafi_exclusions/#{intrafi_exclusion_id}"
  req[:model] = Increase::Models::IntrafiExclusion
  @client.request(req, opts)
end