Class: ModernTreasury::LineItemApi

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

Overview

LineItemApi

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

#get_line_item(itemizable_id, itemizable_type, id) ⇒ ApiResponse

Get a single line item order or expected payment. ‘payment_orders` or `expected_payments`.

Parameters:

  • itemizable_id (String) —

    Required parameter: The ID of the payment

  • itemizable_type (ItemizableType1) —

    Required parameter: One of

  • id (String) —

    Required parameter: The ID of the line item.

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/modern_treasury/apis/line_item_api.rb', line 52

def get_line_item(itemizable_id,
                  itemizable_type,
                  id)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/api/{itemizable_type}/{itemizable_id}/line_items/{id}',
                                 Server::DEFAULT)
               .template_param(new_parameter(itemizable_id, key: 'itemizable_id')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(itemizable_type, key: 'itemizable_type')
                                .is_required(true)
                                .should_encode(true))
               .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(LineItem.method(:from_hash))
                .is_api_response(true))
    .execute
end

#list_line_items(itemizable_id, itemizable_type, after_cursor: nil, per_page: nil) ⇒ ApiResponse

Get a list of line items order or expected payment. ‘payment_orders` or `expected_payments`. here here

Parameters:

  • itemizable_id (String) —

    Required parameter: The ID of the payment

  • itemizable_type (ItemizableType1) —

    Required parameter: One of

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

    Optional parameter: TODO: type description

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

    Optional parameter: TODO: type description

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/modern_treasury/apis/line_item_api.rb', line 19

def list_line_items(itemizable_id,
                    itemizable_type,
                    after_cursor: nil,
                    per_page: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/api/{itemizable_type}/{itemizable_id}/line_items',
                                 Server::DEFAULT)
               .template_param(new_parameter(itemizable_id, key: 'itemizable_id')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(itemizable_type, key: 'itemizable_type')
                                .is_required(true)
                                .should_encode(true))
               .query_param(new_parameter(after_cursor, key: 'after_cursor'))
               .query_param(new_parameter(per_page, key: 'per_page'))
               .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(LineItem.method(:from_hash))
                .is_api_response(true)
                .is_response_array(true))
    .execute
end

#update_line_item(itemizable_id, itemizable_type, id, body: nil) ⇒ ApiResponse

TODO: type endpoint description here order or expected payment. ‘payment_orders` or `expected_payments`. description here

Parameters:

  • itemizable_id (String) —

    Required parameter: The ID of the payment

  • itemizable_type (ItemizableType1) —

    Required parameter: One of

  • id (String) —

    Required parameter: The ID of the line item.

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

    Optional parameter: TODO: type

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/modern_treasury/apis/line_item_api.rb', line 86

def update_line_item(itemizable_id,
                     itemizable_type,
                     id,
                     body: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::PATCH,
                                 '/api/{itemizable_type}/{itemizable_id}/line_items/{id}',
                                 Server::DEFAULT)
               .template_param(new_parameter(itemizable_id, key: 'itemizable_id')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(itemizable_type, key: 'itemizable_type')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(id, key: 'id')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .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(LineItem.method(:from_hash))
                .is_api_response(true)
                .local_error('422',
                             'unsuccessful',
                             ErrorMessageException))
    .execute
end