Class: Paid::OrdersClient

Inherits:
Object
  • Object
show all
Defined in:
lib/paid_ruby/orders/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Paid::OrdersClient

Parameters:



24
25
26
27
 
# File 'lib/paid_ruby/orders/client.rb', line 24

def initialize(request_client:)
  @request_client = request_client
  @lines = Paid::Orders::LinesClient.new(request_client: request_client)
end

Instance Attribute Details

#lines ⇒ Paid::Orders::LinesClient (readonly)

Returns:



19
20
21
 
# File 'lib/paid_ruby/orders/client.rb', line 19

def lines
  @lines
end

#request_client ⇒ Paid::RequestClient (readonly)

Returns:



17
18
19
 
# File 'lib/paid_ruby/orders/client.rb', line 17

def request_client
  @request_client
end

Instance Method Details

#activate(order_id:, request_options: nil) ⇒ Object

api.orders.activate(order_id: “orderId”)



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/paid_ruby/orders/client.rb', line 173

def activate(order_id:, request_options: nil)
  response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/orders/#{order_id}/activate"
end
  Paid::Order.from_json(json_object: response.body)
end

#create(customer_id: nil, customer_external_id: nil, billing_contact_id: nil, name:, description: nil, start_date:, end_date: nil, currency:, order_lines: nil, request_options: nil) ⇒ Object

)



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/paid_ruby/orders/client.rb', line 89

def create(customer_id: nil, customer_external_id: nil, billing_contact_id: nil, name:, description: nil, start_date:, end_date: nil, currency:, order_lines: nil, request_options: nil)
  response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), customerId: customer_id, customerExternalId: customer_external_id, billingContactId: billing_contact_id, name: name, description: description, startDate: start_date, endDate: end_date, currency: currency, orderLines: order_lines }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/orders"
end
  Paid::Order.from_json(json_object: response.body)
end

#delete(order_id:, request_options: nil) ⇒ Object

api.orders.delete(order_id: “orderId”)



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/paid_ruby/orders/client.rb', line 145

def delete(order_id:, request_options: nil)
  response = @request_client.conn.delete do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/orders/#{order_id}"
end
end

#get(order_id:, request_options: nil) ⇒ Object

api.orders.get(order_id: “orderId”)



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/paid_ruby/orders/client.rb', line 116

def get(order_id:, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/orders/#{order_id}"
end
  Paid::Order.from_json(json_object: response.body)
end

#list(request_options: nil) ⇒ Object

api.orders.list



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/paid_ruby/orders/client.rb', line 37

def list(request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/orders"
end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do | item |
    item = item.to_json
    Paid::Order.from_json(json_object: item)
  end
end