module MangoApi::UboDeclarations

Provides API method delegates for the UboDeclaration entity

Public Class Methods

create(user_id, id_key = nil) click to toggle source

Creates a UBO Declaration entity.

UboDeclaration properties:

  • Optional

    • tag

    • declared_ubos

@param user_id [String] ID of the user who the declaration is being created for @return [UboDeclaration] the newly-created UboDeclaration entity object

# 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) click to toggle source
# 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) click to toggle source
# 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) click to toggle source
# 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) click to toggle source
# 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) click to toggle source

Submits a UBO declaration entity for approval.

@param id [String] ID of the UBO declaration to submit @param tag [String] custom data to add with the request @return [UboDeclaration] the submitted UboDeclaration entity object

# 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) click to toggle source
# 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

Private Class Methods

parse(response) click to toggle source

Parses a JSON-originating hash into the corresponding UboDeclaration entity object.

@param response [Hash] JSON-originating data hash @return [UboDeclaration] corresponding UboDeclaration entity object

# File lib/mangopay/api/service/ubo_declarations.rb, line 80
def parse(response)
  MangoModel::UboDeclaration.new.dejsonify response
end
parseUbo(response) click to toggle source
# File lib/mangopay/api/service/ubo_declarations.rb, line 90
def parseUbo(response)
  MangoModel::Ubo.new.dejsonify response
end
parse_ubo_declarations(results) click to toggle source
# File lib/mangopay/api/service/ubo_declarations.rb, line 84
def parse_ubo_declarations(results)
  results.collect do |entity|
    parse entity
  end
end