voltaria_sdk 2.44.0 → 2.45.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/voltaria/clients/client.rb +47 -0
- data/lib/voltaria/clients/types/list_client_limits_request.rb +15 -0
- data/lib/voltaria/types/client_limit_history_response.rb +12 -0
- data/lib/voltaria/types/paginated_response_client_limit_history_response.rb +16 -0
- data/lib/voltaria/version.rb +1 -1
- data/lib/voltaria.rb +3 -0
- data/reference.md +94 -0
- metadata +5 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: babbba3ea4aa527ce026db862386a0125ee9dda1434631662758360fa1a0fe69
|
|
4
|
+
data.tar.gz: c720a108bec5a3e240f07d856d402fc259038bb7a75cc752f97b0f11d771d03f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d189203188759f1f522fd51419e24bb2d3ecf8d5c4f3dc0ee455ddce83f30cd4c1a34b6e26b73784bb4737fbc7ffd3cc445a567fc261c0ef76cf7fc2a6b72896
|
|
7
|
+
data.tar.gz: f7c3af252f9f2d019fcbb3612abc619de13293614b82e41a87b72afb3819f64ec79b03308f57ac8946bed1cbdc05a663eef420052d96867ddca63247a8e0bf0d
|
|
@@ -489,6 +489,53 @@ module Voltaria
|
|
|
489
489
|
end
|
|
490
490
|
end
|
|
491
491
|
|
|
492
|
+
# Retrieve every credit limit granted to a specific client.
|
|
493
|
+
#
|
|
494
|
+
# @param request_options [Hash]
|
|
495
|
+
# @param params [Hash]
|
|
496
|
+
# @option request_options [String] :base_url
|
|
497
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
498
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
499
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
500
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
501
|
+
# @option params [String] :client_id
|
|
502
|
+
# @option params [Integer, nil] :page
|
|
503
|
+
# @option params [Integer, nil] :page_size
|
|
504
|
+
# @option params [String, nil] :order_by
|
|
505
|
+
# @option params [String, nil] :q
|
|
506
|
+
#
|
|
507
|
+
# @return [Voltaria::Types::PaginatedResponseClientLimitHistoryResponse]
|
|
508
|
+
def list_client_limits(request_options: {}, **params)
|
|
509
|
+
params = Voltaria::Internal::Types::Utils.normalize_keys(params)
|
|
510
|
+
query_param_names = %i[page page_size order_by q]
|
|
511
|
+
query_params = {}
|
|
512
|
+
query_params["page"] = params[:page] if params.key?(:page)
|
|
513
|
+
query_params["page_size"] = params[:page_size] if params.key?(:page_size)
|
|
514
|
+
query_params["order_by"] = params[:order_by] if params.key?(:order_by)
|
|
515
|
+
query_params["q"] = params[:q] if params.key?(:q)
|
|
516
|
+
params = params.except(*query_param_names)
|
|
517
|
+
|
|
518
|
+
request = Voltaria::Internal::JSON::Request.new(
|
|
519
|
+
base_url: request_options[:base_url],
|
|
520
|
+
method: "GET",
|
|
521
|
+
path: "v2/clients/#{URI.encode_uri_component(params[:client_id].to_s)}/limits",
|
|
522
|
+
query: query_params,
|
|
523
|
+
request_options: request_options
|
|
524
|
+
)
|
|
525
|
+
begin
|
|
526
|
+
response = @client.send(request)
|
|
527
|
+
rescue Net::HTTPRequestTimeout
|
|
528
|
+
raise Voltaria::Errors::TimeoutError
|
|
529
|
+
end
|
|
530
|
+
code = response.code.to_i
|
|
531
|
+
if code.between?(200, 299)
|
|
532
|
+
Voltaria::Types::PaginatedResponseClientLimitHistoryResponse.load(response.body)
|
|
533
|
+
else
|
|
534
|
+
error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
|
|
535
|
+
raise error_class.new(response.body, code: code)
|
|
536
|
+
end
|
|
537
|
+
end
|
|
538
|
+
|
|
492
539
|
# Retrieve detailed information for a specific client using their client ID.
|
|
493
540
|
#
|
|
494
541
|
# @param request_options [Hash]
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Voltaria
|
|
4
|
+
module Clients
|
|
5
|
+
module Types
|
|
6
|
+
class ListClientLimitsRequest < Internal::Types::Model
|
|
7
|
+
field :client_id, -> { String }, optional: false, nullable: false
|
|
8
|
+
field :page, -> { Integer }, optional: true, nullable: false
|
|
9
|
+
field :page_size, -> { Integer }, optional: true, nullable: false
|
|
10
|
+
field :order_by, -> { String }, optional: true, nullable: false
|
|
11
|
+
field :q, -> { String }, optional: true, nullable: false
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Voltaria
|
|
4
|
+
module Types
|
|
5
|
+
class ClientLimitHistoryResponse < Internal::Types::Model
|
|
6
|
+
field :id, -> { String }, optional: false, nullable: false
|
|
7
|
+
field :created_at, -> { String }, optional: false, nullable: false
|
|
8
|
+
field :currency, -> { Voltaria::Types::CurrencyEnum }, optional: false, nullable: false
|
|
9
|
+
field :limit, -> { String }, optional: false, nullable: false
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Voltaria
|
|
4
|
+
module Types
|
|
5
|
+
class PaginatedResponseClientLimitHistoryResponse < Internal::Types::Model
|
|
6
|
+
field :items, -> { Internal::Types::Array[Voltaria::Types::ClientLimitHistoryResponse] }, optional: false, nullable: false
|
|
7
|
+
field :page, -> { Integer }, optional: true, nullable: false
|
|
8
|
+
field :page_size, -> { Integer }, optional: true, nullable: false
|
|
9
|
+
field :items_in_page, -> { Integer }, optional: true, nullable: false
|
|
10
|
+
field :total_items, -> { Integer }, optional: true, nullable: false
|
|
11
|
+
field :total_pages, -> { Integer }, optional: true, nullable: false
|
|
12
|
+
field :has_next, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
13
|
+
field :has_previous, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
data/lib/voltaria/version.rb
CHANGED
data/lib/voltaria.rb
CHANGED
|
@@ -77,6 +77,7 @@ require_relative "voltaria/types/jurisdiction_enum"
|
|
|
77
77
|
require_relative "voltaria/types/client_base_info"
|
|
78
78
|
require_relative "voltaria/types/client_data_response"
|
|
79
79
|
require_relative "voltaria/types/client_investor_response"
|
|
80
|
+
require_relative "voltaria/types/client_limit_history_response"
|
|
80
81
|
require_relative "voltaria/types/client_limit_response"
|
|
81
82
|
require_relative "voltaria/types/client_response"
|
|
82
83
|
require_relative "voltaria/types/client_user_status_enum"
|
|
@@ -114,6 +115,7 @@ require_relative "voltaria/types/note_response"
|
|
|
114
115
|
require_relative "voltaria/types/paginated_response_checklist_summary_partner_response"
|
|
115
116
|
require_relative "voltaria/types/paginated_response_client_account_response"
|
|
116
117
|
require_relative "voltaria/types/paginated_response_client_investor_response"
|
|
118
|
+
require_relative "voltaria/types/paginated_response_client_limit_history_response"
|
|
117
119
|
require_relative "voltaria/types/paginated_response_client_response"
|
|
118
120
|
require_relative "voltaria/types/paginated_response_client_user_response"
|
|
119
121
|
require_relative "voltaria/types/paginated_response_collection_action_log_response"
|
|
@@ -170,6 +172,7 @@ require_relative "voltaria/clients/types/reject_onboarding_request"
|
|
|
170
172
|
require_relative "voltaria/clients/types/list_client_portal_users_request"
|
|
171
173
|
require_relative "voltaria/clients/types/client_user_invite_request"
|
|
172
174
|
require_relative "voltaria/clients/types/list_client_waivers_request"
|
|
175
|
+
require_relative "voltaria/clients/types/list_client_limits_request"
|
|
173
176
|
require_relative "voltaria/clients/types/get_client_by_id_request"
|
|
174
177
|
require_relative "voltaria/clients/types/delete_client_request"
|
|
175
178
|
require_relative "voltaria/clients/types/list_client_checklist_summaries_request"
|
data/reference.md
CHANGED
|
@@ -996,6 +996,100 @@ client.clients.list_client_waivers(client_id: "client_id")
|
|
|
996
996
|
</dl>
|
|
997
997
|
|
|
998
998
|
|
|
999
|
+
</dd>
|
|
1000
|
+
</dl>
|
|
1001
|
+
</details>
|
|
1002
|
+
|
|
1003
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">list_client_limits</a>(client_id) -> Voltaria::Types::PaginatedResponseClientLimitHistoryResponse</code></summary>
|
|
1004
|
+
<dl>
|
|
1005
|
+
<dd>
|
|
1006
|
+
|
|
1007
|
+
#### 📝 Description
|
|
1008
|
+
|
|
1009
|
+
<dl>
|
|
1010
|
+
<dd>
|
|
1011
|
+
|
|
1012
|
+
<dl>
|
|
1013
|
+
<dd>
|
|
1014
|
+
|
|
1015
|
+
Retrieve every credit limit granted to a specific client.
|
|
1016
|
+
</dd>
|
|
1017
|
+
</dl>
|
|
1018
|
+
</dd>
|
|
1019
|
+
</dl>
|
|
1020
|
+
|
|
1021
|
+
#### 🔌 Usage
|
|
1022
|
+
|
|
1023
|
+
<dl>
|
|
1024
|
+
<dd>
|
|
1025
|
+
|
|
1026
|
+
<dl>
|
|
1027
|
+
<dd>
|
|
1028
|
+
|
|
1029
|
+
```ruby
|
|
1030
|
+
client.clients.list_client_limits(client_id: "client_id")
|
|
1031
|
+
```
|
|
1032
|
+
</dd>
|
|
1033
|
+
</dl>
|
|
1034
|
+
</dd>
|
|
1035
|
+
</dl>
|
|
1036
|
+
|
|
1037
|
+
#### ⚙️ Parameters
|
|
1038
|
+
|
|
1039
|
+
<dl>
|
|
1040
|
+
<dd>
|
|
1041
|
+
|
|
1042
|
+
<dl>
|
|
1043
|
+
<dd>
|
|
1044
|
+
|
|
1045
|
+
**client_id:** `String`
|
|
1046
|
+
|
|
1047
|
+
</dd>
|
|
1048
|
+
</dl>
|
|
1049
|
+
|
|
1050
|
+
<dl>
|
|
1051
|
+
<dd>
|
|
1052
|
+
|
|
1053
|
+
**page:** `Integer`
|
|
1054
|
+
|
|
1055
|
+
</dd>
|
|
1056
|
+
</dl>
|
|
1057
|
+
|
|
1058
|
+
<dl>
|
|
1059
|
+
<dd>
|
|
1060
|
+
|
|
1061
|
+
**page_size:** `Integer`
|
|
1062
|
+
|
|
1063
|
+
</dd>
|
|
1064
|
+
</dl>
|
|
1065
|
+
|
|
1066
|
+
<dl>
|
|
1067
|
+
<dd>
|
|
1068
|
+
|
|
1069
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc'
|
|
1070
|
+
|
|
1071
|
+
</dd>
|
|
1072
|
+
</dl>
|
|
1073
|
+
|
|
1074
|
+
<dl>
|
|
1075
|
+
<dd>
|
|
1076
|
+
|
|
1077
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, currency, created_at, limit. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
1078
|
+
|
|
1079
|
+
</dd>
|
|
1080
|
+
</dl>
|
|
1081
|
+
|
|
1082
|
+
<dl>
|
|
1083
|
+
<dd>
|
|
1084
|
+
|
|
1085
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
1086
|
+
|
|
1087
|
+
</dd>
|
|
1088
|
+
</dl>
|
|
1089
|
+
</dd>
|
|
1090
|
+
</dl>
|
|
1091
|
+
|
|
1092
|
+
|
|
999
1093
|
</dd>
|
|
1000
1094
|
</dl>
|
|
1001
1095
|
</details>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: voltaria_sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.
|
|
4
|
+
version: 2.45.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Voltaria
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-09-
|
|
11
|
+
date: 2026-09-30 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: The Voltaria Ruby library provides convenient access to the Voltaria
|
|
14
14
|
API from Ruby.
|
|
@@ -40,6 +40,7 @@ files:
|
|
|
40
40
|
- lib/voltaria/clients/types/limit_request_create_payload.rb
|
|
41
41
|
- lib/voltaria/clients/types/limit_request_create_payload_requested_limit.rb
|
|
42
42
|
- lib/voltaria/clients/types/list_client_checklist_summaries_request.rb
|
|
43
|
+
- lib/voltaria/clients/types/list_client_limits_request.rb
|
|
43
44
|
- lib/voltaria/clients/types/list_client_portal_users_request.rb
|
|
44
45
|
- lib/voltaria/clients/types/list_client_waivers_request.rb
|
|
45
46
|
- lib/voltaria/clients/types/list_clients_request.rb
|
|
@@ -176,6 +177,7 @@ files:
|
|
|
176
177
|
- lib/voltaria/types/client_base_info.rb
|
|
177
178
|
- lib/voltaria/types/client_data_response.rb
|
|
178
179
|
- lib/voltaria/types/client_investor_response.rb
|
|
180
|
+
- lib/voltaria/types/client_limit_history_response.rb
|
|
179
181
|
- lib/voltaria/types/client_limit_response.rb
|
|
180
182
|
- lib/voltaria/types/client_response.rb
|
|
181
183
|
- lib/voltaria/types/client_status_enum.rb
|
|
@@ -217,6 +219,7 @@ files:
|
|
|
217
219
|
- lib/voltaria/types/paginated_response_checklist_summary_partner_response.rb
|
|
218
220
|
- lib/voltaria/types/paginated_response_client_account_response.rb
|
|
219
221
|
- lib/voltaria/types/paginated_response_client_investor_response.rb
|
|
222
|
+
- lib/voltaria/types/paginated_response_client_limit_history_response.rb
|
|
220
223
|
- lib/voltaria/types/paginated_response_client_response.rb
|
|
221
224
|
- lib/voltaria/types/paginated_response_client_user_response.rb
|
|
222
225
|
- lib/voltaria/types/paginated_response_collection_action_log_response.rb
|