Class: ModernTreasury::InvoiceLineItemController

Inherits:
BaseController show all
Defined in:
lib/modern_treasury/controllers/invoice_line_item_controller.rb

Overview

InvoiceLineItemController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

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

Constructor Details

This class inherits a constructor from ModernTreasury::BaseController

Instance Method Details

#create_invoice_line_item(invoice_id, idempotency_key: nil, body: nil) ⇒ InvoiceLineItem

TODO: type endpoint description here something unique, preferably something like an UUID. description here

Parameters:

  • invoice_id (String) —

    Required parameter: invoice_id

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

    Optional parameter: This key should be

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

    Optional parameter: TODO: type

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/modern_treasury/controllers/invoice_line_item_controller.rb', line 43

def create_invoice_line_item(invoice_id,
                             idempotency_key: nil,
                             body: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/api/invoices/{invoice_id}/invoice_line_items',
                                 Server::DEFAULT)
               .template_param(new_parameter(invoice_id, key: 'invoice_id')
                                .should_encode(true))
               .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(InvoiceLineItem.method(:from_hash)))
    .execute
end

#delete_invoice_line_item(invoice_id, id) ⇒ InvoiceLineItem

TODO: type endpoint description here

Parameters:

  • invoice_id (String) —

    Required parameter: invoice_id

  • id (String) —

    Required parameter: id

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/modern_treasury/controllers/invoice_line_item_controller.rb', line 118

def delete_invoice_line_item(invoice_id,
                             id)
  @api_call
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/api/invoices/{invoice_id}/invoice_line_items/{id}',
                                 Server::DEFAULT)
               .template_param(new_parameter(invoice_id, key: 'invoice_id')
                                .should_encode(true))
               .template_param(new_parameter(id, key: 'id')
                                .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(InvoiceLineItem.method(:from_hash)))
    .execute
end

#get_invoice_line_item(invoice_id, id) ⇒ InvoiceLineItem

TODO: type endpoint description here

Parameters:

  • invoice_id (String) —

    Required parameter: invoice_id

  • id (String) —

    Required parameter: id

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/modern_treasury/controllers/invoice_line_item_controller.rb', line 68

def get_invoice_line_item(invoice_id,
                          id)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/api/invoices/{invoice_id}/invoice_line_items/{id}',
                                 Server::DEFAULT)
               .template_param(new_parameter(invoice_id, key: 'invoice_id')
                                .should_encode(true))
               .template_param(new_parameter(id, key: 'id')
                                .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(InvoiceLineItem.method(:from_hash)))
    .execute
end

#list_invoice_line_items(invoice_id, after_cursor: nil, per_page: nil) ⇒ Array[InvoiceLineItem]

TODO: type endpoint description here here here

Parameters:

  • invoice_id (String) —

    Required parameter: invoice_id

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

    Optional parameter: TODO: type description

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

    Optional parameter: TODO: type description

Returns:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/modern_treasury/controllers/invoice_line_item_controller.rb', line 16

def list_invoice_line_items(invoice_id,
                            after_cursor: nil,
                            per_page: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/api/invoices/{invoice_id}/invoice_line_items',
                                 Server::DEFAULT)
               .template_param(new_parameter(invoice_id, key: 'invoice_id')
                                .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(InvoiceLineItem.method(:from_hash))
                .is_response_array(true))
    .execute
end

#update_invoice_line_item(invoice_id, id, body: nil) ⇒ InvoiceLineItem

TODO: type endpoint description here description here

Parameters:

  • invoice_id (String) —

    Required parameter: invoice_id

  • id (String) —

    Required parameter: id

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

    Optional parameter: TODO: type

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/modern_treasury/controllers/invoice_line_item_controller.rb', line 92

def update_invoice_line_item(invoice_id,
                             id,
                             body: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::PATCH,
                                 '/api/invoices/{invoice_id}/invoice_line_items/{id}',
                                 Server::DEFAULT)
               .template_param(new_parameter(invoice_id, key: 'invoice_id')
                                .should_encode(true))
               .template_param(new_parameter(id, key: 'id')
                                .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(InvoiceLineItem.method(:from_hash)))
    .execute
end