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

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of IntrafiExclusions.

Parameters:



108
109
110
 
# File 'lib/increase/resources/intrafi_exclusions.rb', line 108

def initialize(client:)
  @client = client
end

Instance Method Details

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

Some parameter documentations has been truncated, see Models::IntrafiExclusionArchiveParams for more details.

Archive an IntraFi Exclusion

Parameters:

  • intrafi_exclusion_id (String) —

    The identifier of the IntraFi Exclusion request to archive. It may take 5 busine

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



96
97
98
99
100
101
102
103
 
# File 'lib/increase/resources/intrafi_exclusions.rb', line 96

def archive(intrafi_exclusion_id, params = {})
  @client.request(
    method: :post,
    path: ["intrafi_exclusions/%1$s/archive", intrafi_exclusion_id],
    model: Increase::IntrafiExclusion,
    options: params[:request_options]
  )
end

#create(bank_name: , entity_id: , request_options: {}) ⇒ Increase::Models::IntrafiExclusion

Create an IntraFi Exclusion

Parameters:

  • 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.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



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

def create(params)
  parsed, options = Increase::IntrafiExclusionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "intrafi_exclusions",
    body: parsed,
    model: Increase::IntrafiExclusion,
    options: options
  )
end

#list(cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::IntrafiExclusion>

Some parameter documentations has been truncated, see Models::IntrafiExclusionListParams for more details.

List IntraFi Exclusions

Parameters:

  • 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 tha

  • limit (Integer) —

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

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/increase/resources/intrafi_exclusions.rb', line 70

def list(params = {})
  parsed, options = Increase::IntrafiExclusionListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "intrafi_exclusions",
    query: parsed,
    page: Increase::Internal::Page,
    model: Increase::IntrafiExclusion,
    options: options
  )
end

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

Get an IntraFi Exclusion

Parameters:

  • intrafi_exclusion_id (String) —

    The identifier of the IntraFi Exclusion to retrieve.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



41
42
43
44
45
46
47
48
 
# File 'lib/increase/resources/intrafi_exclusions.rb', line 41

def retrieve(intrafi_exclusion_id, params = {})
  @client.request(
    method: :get,
    path: ["intrafi_exclusions/%1$s", intrafi_exclusion_id],
    model: Increase::IntrafiExclusion,
    options: params[:request_options]
  )
end