Class: ModernTreasury::ReturnApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/modern_treasury/apis/return_api.rb

Overview

ReturnApi

Constant Summary

Constants inherited from BaseApi

BaseApi::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseApi

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseApi

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from ModernTreasury::BaseApi

Instance Method Details

#create_return(idempotency_key: nil, body: nil) ⇒ ApiResponse

Create a return. something unique, preferably something like an UUID. description here

Parameters:

  • idempotency_key (String) (defaults to: nil) —

    Optional parameter: This key should be

  • body (ReturnCreateRequest) (defaults to: nil) —

    Optional parameter: TODO: type

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/modern_treasury/apis/return_api.rb', line 61

def create_return(idempotency_key: nil,
                  body: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/api/returns',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('basic_auth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(Return.method(:from_hash))
                .is_api_response(true)
                .local_error('404',
                             'unsuccessful',
                             ErrorMessageException)
                .local_error('422',
                             'unsuccessful',
                             ErrorMessageException))
    .execute
end

#get_return(id) ⇒ ApiResponse

Get a single return.

Parameters:

  • id (String) —

    Required parameter: The ID of an existing return.

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/modern_treasury/apis/return_api.rb', line 89

def get_return(id)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/api/returns/{id}',
                                 Server::DEFAULT)
               .template_param(new_parameter(id, key: 'id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('basic_auth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(Return.method(:from_hash))
                .is_api_response(true)
                .local_error('404',
                             'not found',
                             ErrorMessageException))
    .execute
end

#list_returns(after_cursor: nil, per_page: nil, internal_account_id: nil, counterparty_id: nil, returnable_id: nil, returnable_type: nil) ⇒ ApiResponse

Get a list of returns. here here ‘internal_account_id` if you wish to see returns to/from a specific account. `counterparty_id` if you wish to see returns that occurred with a specific counterparty. returnable. Must be accompanied by `returnable_type`. `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`. Must be accompanied by `returnable_id`.

Parameters:

  • after_cursor (String) (defaults to: nil) —

    Optional parameter: TODO: type description

  • per_page (Integer) (defaults to: nil) —

    Optional parameter: TODO: type description

  • internal_account_id (String) (defaults to: nil) —

    Optional parameter: Specify

  • counterparty_id (String) (defaults to: nil) —

    Optional parameter: Specify

  • returnable_id (String) (defaults to: nil) —

    Optional parameter: The ID of a valid

  • returnable_type (ReturnableType1) (defaults to: nil) —

    Optional parameter: One of

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/modern_treasury/apis/return_api.rb', line 26

def list_returns(after_cursor: nil,
                 per_page: nil,
                 internal_account_id: nil,
                 counterparty_id: nil,
                 returnable_id: nil,
                 returnable_type: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/api/returns',
                                 Server::DEFAULT)
               .query_param(new_parameter(after_cursor, key: 'after_cursor'))
               .query_param(new_parameter(per_page, key: 'per_page'))
               .query_param(new_parameter(, key: 'internal_account_id'))
               .query_param(new_parameter(counterparty_id, key: 'counterparty_id'))
               .query_param(new_parameter(returnable_id, key: 'returnable_id'))
               .query_param(new_parameter(returnable_type, key: 'returnable_type'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('basic_auth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(Return.method(:from_hash))
                .is_api_response(true)
                .is_response_array(true)
                .local_error('401',
                             'unsuccessful',
                             ErrorMessageException))
    .execute
end