Module: MangoApi::UboDeclarations

Extended by:
UriProvider
Defined in:
lib/mangopay/api/service/ubo_declarations.rb

Overview

Provides API method delegates for the UboDeclaration entity

Class Method Summary collapse

Methods included from UriProvider

provide_uri

Class Method Details

.create(user_id, id_key = nil) ⇒ UboDeclaration

Creates a UBO Declaration entity.

UboDeclaration properties:

  • Optional

    • tag

    • declared_ubos

being created for

Parameters:

  • +user_id+ (String) —

    ID of the user who the declaration is

Returns:

  • (UboDeclaration) —

    the newly-created UboDeclaration entity object



21
22
23
24
25
 
# File 'lib/mangopay/api/service/ubo_declarations.rb', line 21

def create(user_id, id_key = nil)
  uri = provide_uri(:create_ubo_declaration, user_id)
  response = HttpClient.post(uri, nil, id_key)
  parse response
end

.create_ubo(user_id, ubo_declaration_id, ubo, id_key = nil) ⇒ Object 



43
44
45
46
47
 
# File 'lib/mangopay/api/service/ubo_declarations.rb', line 43

def create_ubo(user_id, ubo_declaration_id, ubo, id_key = nil)
  uri = provide_uri(:create_ubo, user_id, ubo_declaration_id)
  response = HttpClient.post(uri, ubo, id_key)
  parseUbo response
end

.get(user_id, ubo_declaration_id, id_key = nil) ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/mangopay/api/service/ubo_declarations.rb', line 33

def get(user_id, ubo_declaration_id, id_key = nil)
  uri = if user_id != nil
          provide_uri(:get_ubo_declaration, user_id, ubo_declaration_id)
        else
          provide_uri(:get_ubo_declaration_by_id, ubo_declaration_id)
        end
  response = HttpClient.get(uri, id_key)
  parse response
end

.get_all(user_id, id_key = nil) ⇒ Object 



27
28
29
30
31
 
# File 'lib/mangopay/api/service/ubo_declarations.rb', line 27

def get_all(user_id, id_key = nil)
  uri = provide_uri(:all_ubo_declaration, user_id)
  response = HttpClient.get(uri, id_key)
  parse_ubo_declarations response
end

.get_ubo(user_id, ubo_declaration_id, ubo_id, id_key = nil) ⇒ Object 



55
56
57
58
59
 
# File 'lib/mangopay/api/service/ubo_declarations.rb', line 55

def get_ubo(user_id, ubo_declaration_id, ubo_id, id_key = nil)
  uri = provide_uri(:get_ubo, user_id, ubo_declaration_id, ubo_id)
  response = HttpClient.get(uri, id_key)
  parseUbo response
end

.submit(user_id, ubo_declaration_id, tag = nil) ⇒ UboDeclaration

Submits a UBO declaration entity for approval.

Parameters:

  • +id+ (String) —

    ID of the UBO declaration to submit

  • +tag+ (String) —

    custom data to add with the request

Returns:

  • (UboDeclaration) —

    the submitted UboDeclaration entity object



66
67
68
69
70
71
 
# File 'lib/mangopay/api/service/ubo_declarations.rb', line 66

def submit(user_id, ubo_declaration_id, tag = nil)
  uri = provide_uri(:submit_ubo_declaration, user_id, ubo_declaration_id)
  submit_request = SubmitUboDeclarationRequest.new(ubo_declaration_id, tag)
  response = HttpClient.put(uri, submit_request)
  parse response
end

.update_ubo(user_id, ubo_declaration_id, ubo) ⇒ Object 



49
50
51
52
53
 
# File 'lib/mangopay/api/service/ubo_declarations.rb', line 49

def update_ubo(user_id, ubo_declaration_id, ubo)
  uri = provide_uri(:update_ubo, user_id, ubo_declaration_id, ubo.id)
  response = HttpClient.put(uri, ubo)
  parseUbo response
end