payabli 2.2.20 → 2.2.21
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/.fern/metadata.json +4 -3
- data/LICENSE.md +5 -6
- data/README.md +6 -0
- data/lib/payabli/bill/client.rb +11 -11
- data/lib/payabli/boarding/client.rb +10 -10
- data/lib/payabli/charge_backs/client.rb +3 -3
- data/lib/payabli/client.rb +11 -1
- data/lib/payabli/cloud/client.rb +4 -4
- data/lib/payabli/customer/client.rb +6 -6
- data/lib/payabli/export/client.rb +29 -29
- data/lib/payabli/ghost_card/client.rb +99 -0
- data/lib/payabli/ghost_card/types/card_status.rb +16 -0
- data/lib/payabli/ghost_card/types/create_ghost_card_request_body.rb +27 -0
- data/lib/payabli/ghost_card/types/create_ghost_card_response.rb +14 -0
- data/lib/payabli/ghost_card/types/create_ghost_card_response_data.rb +13 -0
- data/lib/payabli/ghost_card/types/update_card_request_body.rb +13 -0
- data/lib/payabli/hosted_payment_pages/client.rb +3 -3
- data/lib/payabli/import/client.rb +3 -3
- data/lib/payabli/invoice/client.rb +11 -11
- data/lib/payabli/line_item/client.rb +5 -5
- data/lib/payabli/money_in/client.rb +13 -13
- data/lib/payabli/money_out/client.rb +7 -7
- data/lib/payabli/notification/client.rb +4 -4
- data/lib/payabli/notificationlogs/client.rb +2 -2
- data/lib/payabli/ocr/client.rb +2 -2
- data/lib/payabli/organization/client.rb +6 -6
- data/lib/payabli/payment_link/client.rb +11 -11
- data/lib/payabli/payment_method_domain/client.rb +5 -5
- data/lib/payabli/payout_subscription/client.rb +160 -0
- data/lib/payabli/payout_subscription/types/add_payout_subscription_response.rb +15 -0
- data/lib/payabli/payout_subscription/types/delete_payout_subscription_response.rb +14 -0
- data/lib/payabli/payout_subscription/types/get_payout_subscription_response.rb +14 -0
- data/lib/payabli/payout_subscription/types/payout_payment_detail.rb +24 -0
- data/lib/payabli/payout_subscription/types/payout_schedule_detail.rb +13 -0
- data/lib/payabli/payout_subscription/types/payout_set_pause.rb +25 -0
- data/lib/payabli/payout_subscription/types/payout_subscription_query_record.rb +39 -0
- data/lib/payabli/payout_subscription/types/payout_subscription_query_record_pascal.rb +39 -0
- data/lib/payabli/payout_subscription/types/payout_subscription_request_body.rb +20 -0
- data/lib/payabli/payout_subscription/types/query_payout_subscription_response.rb +13 -0
- data/lib/payabli/payout_subscription/types/request_payout_schedule.rb +12 -0
- data/lib/payabli/payout_subscription/types/update_payout_subscription_body.rb +14 -0
- data/lib/payabli/payout_subscription/types/update_payout_subscription_response.rb +15 -0
- data/lib/payabli/paypoint/client.rb +7 -7
- data/lib/payabli/query/client.rb +143 -43
- data/lib/payabli/query/types/list_payout_subscriptions_org_request.rb +16 -0
- data/lib/payabli/query/types/list_payout_subscriptions_request.rb +16 -0
- data/lib/payabli/statistic/client.rb +4 -4
- data/lib/payabli/subscription/client.rb +3 -3
- data/lib/payabli/templates/client.rb +4 -4
- data/lib/payabli/token_storage/client.rb +3 -3
- data/lib/payabli/user/client.rb +6 -6
- data/lib/payabli/vendor/client.rb +4 -4
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +22 -0
- data/reference.md +1304 -372
- data/wiremock/wiremock-mappings.json +1 -1
- metadata +23 -1
|
@@ -27,7 +27,7 @@ module Payabli
|
|
|
27
27
|
request = Payabli::Internal::JSON::Request.new(
|
|
28
28
|
base_url: request_options[:base_url],
|
|
29
29
|
method: "GET",
|
|
30
|
-
path: "Paypoint/basic/#{params[:entry]}",
|
|
30
|
+
path: "Paypoint/basic/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
31
31
|
request_options: request_options
|
|
32
32
|
)
|
|
33
33
|
begin
|
|
@@ -61,7 +61,7 @@ module Payabli
|
|
|
61
61
|
request = Payabli::Internal::JSON::Request.new(
|
|
62
62
|
base_url: request_options[:base_url],
|
|
63
63
|
method: "GET",
|
|
64
|
-
path: "Paypoint/basicById/#{params[:id_paypoint]}",
|
|
64
|
+
path: "Paypoint/basicById/#{URI.encode_uri_component(params[:id_paypoint].to_s)}",
|
|
65
65
|
request_options: request_options
|
|
66
66
|
)
|
|
67
67
|
begin
|
|
@@ -101,7 +101,7 @@ module Payabli
|
|
|
101
101
|
request = Payabli::Internal::JSON::Request.new(
|
|
102
102
|
base_url: request_options[:base_url],
|
|
103
103
|
method: "GET",
|
|
104
|
-
path: "Paypoint/#{params[:entry]}",
|
|
104
|
+
path: "Paypoint/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
105
105
|
query: query_params,
|
|
106
106
|
request_options: request_options
|
|
107
107
|
)
|
|
@@ -137,7 +137,7 @@ module Payabli
|
|
|
137
137
|
request = Payabli::Internal::JSON::Request.new(
|
|
138
138
|
base_url: request_options[:base_url],
|
|
139
139
|
method: "GET",
|
|
140
|
-
path: "Paypoint/#{params[:entry]}/#{params[:subdomain]}",
|
|
140
|
+
path: "Paypoint/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:subdomain].to_s)}",
|
|
141
141
|
request_options: request_options
|
|
142
142
|
)
|
|
143
143
|
begin
|
|
@@ -172,7 +172,7 @@ module Payabli
|
|
|
172
172
|
request = Payabli::Internal::JSON::Request.new(
|
|
173
173
|
base_url: request_options[:base_url],
|
|
174
174
|
method: "DELETE",
|
|
175
|
-
path: "Paypoint/#{params[:entry]}/#{params[:subdomain]}",
|
|
175
|
+
path: "Paypoint/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:subdomain].to_s)}",
|
|
176
176
|
request_options: request_options
|
|
177
177
|
)
|
|
178
178
|
begin
|
|
@@ -206,7 +206,7 @@ module Payabli
|
|
|
206
206
|
request = Payabli::Internal::JSON::Request.new(
|
|
207
207
|
base_url: request_options[:base_url],
|
|
208
208
|
method: "PUT",
|
|
209
|
-
path: "Paypoint/logo/#{params[:entry]}",
|
|
209
|
+
path: "Paypoint/logo/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
210
210
|
body: Payabli::Types::FileContent.new(params).to_h,
|
|
211
211
|
request_options: request_options
|
|
212
212
|
)
|
|
@@ -241,7 +241,7 @@ module Payabli
|
|
|
241
241
|
request = Payabli::Internal::JSON::Request.new(
|
|
242
242
|
base_url: request_options[:base_url],
|
|
243
243
|
method: "GET",
|
|
244
|
-
path: "Paypoint/settings/#{params[:entry]}",
|
|
244
|
+
path: "Paypoint/settings/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
245
245
|
request_options: request_options
|
|
246
246
|
)
|
|
247
247
|
begin
|
data/lib/payabli/query/client.rb
CHANGED
|
@@ -43,7 +43,7 @@ module Payabli
|
|
|
43
43
|
request = Payabli::Internal::JSON::Request.new(
|
|
44
44
|
base_url: request_options[:base_url],
|
|
45
45
|
method: "GET",
|
|
46
|
-
path: "Query/batchDetails/#{params[:entry]}",
|
|
46
|
+
path: "Query/batchDetails/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
47
47
|
query: query_params,
|
|
48
48
|
request_options: request_options
|
|
49
49
|
)
|
|
@@ -94,7 +94,7 @@ module Payabli
|
|
|
94
94
|
request = Payabli::Internal::JSON::Request.new(
|
|
95
95
|
base_url: request_options[:base_url],
|
|
96
96
|
method: "GET",
|
|
97
|
-
path: "Query/batchDetails/org/#{params[:org_id]}",
|
|
97
|
+
path: "Query/batchDetails/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
98
98
|
query: query_params,
|
|
99
99
|
request_options: request_options
|
|
100
100
|
)
|
|
@@ -144,7 +144,7 @@ module Payabli
|
|
|
144
144
|
request = Payabli::Internal::JSON::Request.new(
|
|
145
145
|
base_url: request_options[:base_url],
|
|
146
146
|
method: "GET",
|
|
147
|
-
path: "Query/batches/#{params[:entry]}",
|
|
147
|
+
path: "Query/batches/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
148
148
|
query: query_params,
|
|
149
149
|
request_options: request_options
|
|
150
150
|
)
|
|
@@ -194,7 +194,7 @@ module Payabli
|
|
|
194
194
|
request = Payabli::Internal::JSON::Request.new(
|
|
195
195
|
base_url: request_options[:base_url],
|
|
196
196
|
method: "GET",
|
|
197
|
-
path: "Query/batches/org/#{params[:org_id]}",
|
|
197
|
+
path: "Query/batches/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
198
198
|
query: query_params,
|
|
199
199
|
request_options: request_options
|
|
200
200
|
)
|
|
@@ -244,7 +244,7 @@ module Payabli
|
|
|
244
244
|
request = Payabli::Internal::JSON::Request.new(
|
|
245
245
|
base_url: request_options[:base_url],
|
|
246
246
|
method: "GET",
|
|
247
|
-
path: "Query/batchesOut/#{params[:entry]}",
|
|
247
|
+
path: "Query/batchesOut/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
248
248
|
query: query_params,
|
|
249
249
|
request_options: request_options
|
|
250
250
|
)
|
|
@@ -294,7 +294,7 @@ module Payabli
|
|
|
294
294
|
request = Payabli::Internal::JSON::Request.new(
|
|
295
295
|
base_url: request_options[:base_url],
|
|
296
296
|
method: "GET",
|
|
297
|
-
path: "Query/batchesOut/org/#{params[:org_id]}",
|
|
297
|
+
path: "Query/batchesOut/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
298
298
|
query: query_params,
|
|
299
299
|
request_options: request_options
|
|
300
300
|
)
|
|
@@ -344,7 +344,7 @@ module Payabli
|
|
|
344
344
|
request = Payabli::Internal::JSON::Request.new(
|
|
345
345
|
base_url: request_options[:base_url],
|
|
346
346
|
method: "GET",
|
|
347
|
-
path: "Query/chargebacks/#{params[:entry]}",
|
|
347
|
+
path: "Query/chargebacks/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
348
348
|
query: query_params,
|
|
349
349
|
request_options: request_options
|
|
350
350
|
)
|
|
@@ -394,7 +394,7 @@ module Payabli
|
|
|
394
394
|
request = Payabli::Internal::JSON::Request.new(
|
|
395
395
|
base_url: request_options[:base_url],
|
|
396
396
|
method: "GET",
|
|
397
|
-
path: "Query/chargebacks/org/#{params[:org_id]}",
|
|
397
|
+
path: "Query/chargebacks/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
398
398
|
query: query_params,
|
|
399
399
|
request_options: request_options
|
|
400
400
|
)
|
|
@@ -444,7 +444,7 @@ module Payabli
|
|
|
444
444
|
request = Payabli::Internal::JSON::Request.new(
|
|
445
445
|
base_url: request_options[:base_url],
|
|
446
446
|
method: "GET",
|
|
447
|
-
path: "Query/customers/#{params[:entry]}",
|
|
447
|
+
path: "Query/customers/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
448
448
|
query: query_params,
|
|
449
449
|
request_options: request_options
|
|
450
450
|
)
|
|
@@ -494,7 +494,7 @@ module Payabli
|
|
|
494
494
|
request = Payabli::Internal::JSON::Request.new(
|
|
495
495
|
base_url: request_options[:base_url],
|
|
496
496
|
method: "GET",
|
|
497
|
-
path: "Query/customers/org/#{params[:org_id]}",
|
|
497
|
+
path: "Query/customers/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
498
498
|
query: query_params,
|
|
499
499
|
request_options: request_options
|
|
500
500
|
)
|
|
@@ -542,7 +542,7 @@ module Payabli
|
|
|
542
542
|
request = Payabli::Internal::JSON::Request.new(
|
|
543
543
|
base_url: request_options[:base_url],
|
|
544
544
|
method: "GET",
|
|
545
|
-
path: "Query/notificationReports/#{params[:entry]}",
|
|
545
|
+
path: "Query/notificationReports/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
546
546
|
query: query_params,
|
|
547
547
|
request_options: request_options
|
|
548
548
|
)
|
|
@@ -589,7 +589,7 @@ module Payabli
|
|
|
589
589
|
request = Payabli::Internal::JSON::Request.new(
|
|
590
590
|
base_url: request_options[:base_url],
|
|
591
591
|
method: "GET",
|
|
592
|
-
path: "Query/notificationReports/org/#{params[:org_id]}",
|
|
592
|
+
path: "Query/notificationReports/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
593
593
|
query: query_params,
|
|
594
594
|
request_options: request_options
|
|
595
595
|
)
|
|
@@ -636,7 +636,7 @@ module Payabli
|
|
|
636
636
|
request = Payabli::Internal::JSON::Request.new(
|
|
637
637
|
base_url: request_options[:base_url],
|
|
638
638
|
method: "GET",
|
|
639
|
-
path: "Query/notifications/#{params[:entry]}",
|
|
639
|
+
path: "Query/notifications/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
640
640
|
query: query_params,
|
|
641
641
|
request_options: request_options
|
|
642
642
|
)
|
|
@@ -683,7 +683,7 @@ module Payabli
|
|
|
683
683
|
request = Payabli::Internal::JSON::Request.new(
|
|
684
684
|
base_url: request_options[:base_url],
|
|
685
685
|
method: "GET",
|
|
686
|
-
path: "Query/notifications/org/#{params[:org_id]}",
|
|
686
|
+
path: "Query/notifications/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
687
687
|
query: query_params,
|
|
688
688
|
request_options: request_options
|
|
689
689
|
)
|
|
@@ -734,7 +734,7 @@ module Payabli
|
|
|
734
734
|
request = Payabli::Internal::JSON::Request.new(
|
|
735
735
|
base_url: request_options[:base_url],
|
|
736
736
|
method: "GET",
|
|
737
|
-
path: "Query/organizations/#{params[:org_id]}",
|
|
737
|
+
path: "Query/organizations/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
738
738
|
query: query_params,
|
|
739
739
|
request_options: request_options
|
|
740
740
|
)
|
|
@@ -784,7 +784,7 @@ module Payabli
|
|
|
784
784
|
request = Payabli::Internal::JSON::Request.new(
|
|
785
785
|
base_url: request_options[:base_url],
|
|
786
786
|
method: "GET",
|
|
787
|
-
path: "Query/payouts/#{params[:entry]}",
|
|
787
|
+
path: "Query/payouts/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
788
788
|
query: query_params,
|
|
789
789
|
request_options: request_options
|
|
790
790
|
)
|
|
@@ -834,7 +834,7 @@ module Payabli
|
|
|
834
834
|
request = Payabli::Internal::JSON::Request.new(
|
|
835
835
|
base_url: request_options[:base_url],
|
|
836
836
|
method: "GET",
|
|
837
|
-
path: "Query/payouts/org/#{params[:org_id]}",
|
|
837
|
+
path: "Query/payouts/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
838
838
|
query: query_params,
|
|
839
839
|
request_options: request_options
|
|
840
840
|
)
|
|
@@ -884,7 +884,7 @@ module Payabli
|
|
|
884
884
|
request = Payabli::Internal::JSON::Request.new(
|
|
885
885
|
base_url: request_options[:base_url],
|
|
886
886
|
method: "GET",
|
|
887
|
-
path: "Query/paypoints/#{params[:org_id]}",
|
|
887
|
+
path: "Query/paypoints/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
888
888
|
query: query_params,
|
|
889
889
|
request_options: request_options
|
|
890
890
|
)
|
|
@@ -934,7 +934,7 @@ module Payabli
|
|
|
934
934
|
request = Payabli::Internal::JSON::Request.new(
|
|
935
935
|
base_url: request_options[:base_url],
|
|
936
936
|
method: "GET",
|
|
937
|
-
path: "Query/settlements/#{params[:entry]}",
|
|
937
|
+
path: "Query/settlements/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
938
938
|
query: query_params,
|
|
939
939
|
request_options: request_options
|
|
940
940
|
)
|
|
@@ -984,7 +984,7 @@ module Payabli
|
|
|
984
984
|
request = Payabli::Internal::JSON::Request.new(
|
|
985
985
|
base_url: request_options[:base_url],
|
|
986
986
|
method: "GET",
|
|
987
|
-
path: "Query/settlements/org/#{params[:org_id]}",
|
|
987
|
+
path: "Query/settlements/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
988
988
|
query: query_params,
|
|
989
989
|
request_options: request_options
|
|
990
990
|
)
|
|
@@ -1034,7 +1034,7 @@ module Payabli
|
|
|
1034
1034
|
request = Payabli::Internal::JSON::Request.new(
|
|
1035
1035
|
base_url: request_options[:base_url],
|
|
1036
1036
|
method: "GET",
|
|
1037
|
-
path: "Query/subscriptions/#{params[:entry]}",
|
|
1037
|
+
path: "Query/subscriptions/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
1038
1038
|
query: query_params,
|
|
1039
1039
|
request_options: request_options
|
|
1040
1040
|
)
|
|
@@ -1084,7 +1084,7 @@ module Payabli
|
|
|
1084
1084
|
request = Payabli::Internal::JSON::Request.new(
|
|
1085
1085
|
base_url: request_options[:base_url],
|
|
1086
1086
|
method: "GET",
|
|
1087
|
-
path: "Query/subscriptions/org/#{params[:org_id]}",
|
|
1087
|
+
path: "Query/subscriptions/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
1088
1088
|
query: query_params,
|
|
1089
1089
|
request_options: request_options
|
|
1090
1090
|
)
|
|
@@ -1102,15 +1102,116 @@ module Payabli
|
|
|
1102
1102
|
end
|
|
1103
1103
|
end
|
|
1104
1104
|
|
|
1105
|
+
# Returns a list of payout subscriptions for a single paypoint. Use filters to limit results. Include the
|
|
1106
|
+
# `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout
|
|
1107
|
+
# subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
1108
|
+
#
|
|
1109
|
+
# @param request_options [Hash]
|
|
1110
|
+
# @param params [Hash]
|
|
1111
|
+
# @option request_options [String] :base_url
|
|
1112
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
1113
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
1114
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
1115
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
1116
|
+
# @option params [Payabli::Types::Entry] :entry
|
|
1117
|
+
# @option params [Payabli::Types::ExportFormat, nil] :export_format
|
|
1118
|
+
# @option params [Integer, nil] :from_record
|
|
1119
|
+
# @option params [Integer, nil] :limit_record
|
|
1120
|
+
# @option params [Hash[String, String, nil], nil] :parameters
|
|
1121
|
+
# @option params [String, nil] :sort_by
|
|
1122
|
+
#
|
|
1123
|
+
# @return [Payabli::PayoutSubscription::Types::QueryPayoutSubscriptionResponse]
|
|
1124
|
+
def list_payout_subscriptions(request_options: {}, **params)
|
|
1125
|
+
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
1126
|
+
query_param_names = %i[export_format from_record limit_record parameters sort_by]
|
|
1127
|
+
query_params = {}
|
|
1128
|
+
query_params["exportFormat"] = params[:export_format] if params.key?(:export_format)
|
|
1129
|
+
query_params["fromRecord"] = params[:from_record] if params.key?(:from_record)
|
|
1130
|
+
query_params["limitRecord"] = params[:limit_record] if params.key?(:limit_record)
|
|
1131
|
+
query_params["parameters"] = params[:parameters] if params.key?(:parameters)
|
|
1132
|
+
query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
|
|
1133
|
+
params = params.except(*query_param_names)
|
|
1134
|
+
|
|
1135
|
+
request = Payabli::Internal::JSON::Request.new(
|
|
1136
|
+
base_url: request_options[:base_url],
|
|
1137
|
+
method: "GET",
|
|
1138
|
+
path: "Query/payoutsubscriptions/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
1139
|
+
query: query_params,
|
|
1140
|
+
request_options: request_options
|
|
1141
|
+
)
|
|
1142
|
+
begin
|
|
1143
|
+
response = @client.send(request)
|
|
1144
|
+
rescue Net::HTTPRequestTimeout
|
|
1145
|
+
raise Payabli::Errors::TimeoutError
|
|
1146
|
+
end
|
|
1147
|
+
code = response.code.to_i
|
|
1148
|
+
if code.between?(200, 299)
|
|
1149
|
+
Payabli::PayoutSubscription::Types::QueryPayoutSubscriptionResponse.load(response.body)
|
|
1150
|
+
else
|
|
1151
|
+
error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
|
|
1152
|
+
raise error_class.new(response.body, code: code)
|
|
1153
|
+
end
|
|
1154
|
+
end
|
|
1155
|
+
|
|
1156
|
+
# Returns a list of payout subscriptions for a single org. Use filters to limit results. Include the
|
|
1157
|
+
# `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout
|
|
1158
|
+
# subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
1159
|
+
#
|
|
1160
|
+
# @param request_options [Hash]
|
|
1161
|
+
# @param params [Hash]
|
|
1162
|
+
# @option request_options [String] :base_url
|
|
1163
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
1164
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
1165
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
1166
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
1167
|
+
# @option params [Integer] :org_id
|
|
1168
|
+
# @option params [Payabli::Types::ExportFormat, nil] :export_format
|
|
1169
|
+
# @option params [Integer, nil] :from_record
|
|
1170
|
+
# @option params [Integer, nil] :limit_record
|
|
1171
|
+
# @option params [Hash[String, String, nil], nil] :parameters
|
|
1172
|
+
# @option params [String, nil] :sort_by
|
|
1173
|
+
#
|
|
1174
|
+
# @return [Payabli::PayoutSubscription::Types::QueryPayoutSubscriptionResponse]
|
|
1175
|
+
def list_payout_subscriptions_org(request_options: {}, **params)
|
|
1176
|
+
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
1177
|
+
query_param_names = %i[export_format from_record limit_record parameters sort_by]
|
|
1178
|
+
query_params = {}
|
|
1179
|
+
query_params["exportFormat"] = params[:export_format] if params.key?(:export_format)
|
|
1180
|
+
query_params["fromRecord"] = params[:from_record] if params.key?(:from_record)
|
|
1181
|
+
query_params["limitRecord"] = params[:limit_record] if params.key?(:limit_record)
|
|
1182
|
+
query_params["parameters"] = params[:parameters] if params.key?(:parameters)
|
|
1183
|
+
query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
|
|
1184
|
+
params = params.except(*query_param_names)
|
|
1185
|
+
|
|
1186
|
+
request = Payabli::Internal::JSON::Request.new(
|
|
1187
|
+
base_url: request_options[:base_url],
|
|
1188
|
+
method: "GET",
|
|
1189
|
+
path: "Query/payoutsubscriptions/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
1190
|
+
query: query_params,
|
|
1191
|
+
request_options: request_options
|
|
1192
|
+
)
|
|
1193
|
+
begin
|
|
1194
|
+
response = @client.send(request)
|
|
1195
|
+
rescue Net::HTTPRequestTimeout
|
|
1196
|
+
raise Payabli::Errors::TimeoutError
|
|
1197
|
+
end
|
|
1198
|
+
code = response.code.to_i
|
|
1199
|
+
if code.between?(200, 299)
|
|
1200
|
+
Payabli::PayoutSubscription::Types::QueryPayoutSubscriptionResponse.load(response.body)
|
|
1201
|
+
else
|
|
1202
|
+
error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
|
|
1203
|
+
raise error_class.new(response.body, code: code)
|
|
1204
|
+
end
|
|
1205
|
+
end
|
|
1206
|
+
|
|
1105
1207
|
# Retrieve a list of transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query
|
|
1106
1208
|
# parameter to return the results as a file instead of a JSON response.
|
|
1107
1209
|
# By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this
|
|
1108
1210
|
# period, include `transactionDate` filters.
|
|
1109
1211
|
# For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
1110
|
-
# ``` curl
|
|
1111
|
-
# --url
|
|
1212
|
+
# ``` curl -X GET
|
|
1112
1213
|
# https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
|
|
1113
|
-
#
|
|
1214
|
+
# -H 'requestToken: <API TOKEN>'
|
|
1114
1215
|
#
|
|
1115
1216
|
# ```
|
|
1116
1217
|
#
|
|
@@ -1143,7 +1244,7 @@ module Payabli
|
|
|
1143
1244
|
request = Payabli::Internal::JSON::Request.new(
|
|
1144
1245
|
base_url: request_options[:base_url],
|
|
1145
1246
|
method: "GET",
|
|
1146
|
-
path: "Query/transactions/#{params[:entry]}",
|
|
1247
|
+
path: "Query/transactions/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
1147
1248
|
query: query_params,
|
|
1148
1249
|
request_options: request_options
|
|
1149
1250
|
)
|
|
@@ -1173,10 +1274,9 @@ module Payabli
|
|
|
1173
1274
|
# For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
1174
1275
|
#
|
|
1175
1276
|
# ```
|
|
1176
|
-
# curl
|
|
1177
|
-
#
|
|
1178
|
-
#
|
|
1179
|
-
# --header 'requestToken: <api-key>'
|
|
1277
|
+
# curl -X GET
|
|
1278
|
+
# "https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59"\
|
|
1279
|
+
# -H 'requestToken: <API TOKEN>'
|
|
1180
1280
|
#
|
|
1181
1281
|
# ```
|
|
1182
1282
|
#
|
|
@@ -1209,7 +1309,7 @@ module Payabli
|
|
|
1209
1309
|
request = Payabli::Internal::JSON::Request.new(
|
|
1210
1310
|
base_url: request_options[:base_url],
|
|
1211
1311
|
method: "GET",
|
|
1212
|
-
path: "Query/transactions/org/#{params[:org_id]}",
|
|
1312
|
+
path: "Query/transactions/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
1213
1313
|
query: query_params,
|
|
1214
1314
|
request_options: request_options
|
|
1215
1315
|
)
|
|
@@ -1260,7 +1360,7 @@ module Payabli
|
|
|
1260
1360
|
request = Payabli::Internal::JSON::Request.new(
|
|
1261
1361
|
base_url: request_options[:base_url],
|
|
1262
1362
|
method: "GET",
|
|
1263
|
-
path: "Query/transferDetails/#{params[:entry]}/#{params[:transfer_id]}",
|
|
1363
|
+
path: "Query/transferDetails/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:transfer_id].to_s)}",
|
|
1264
1364
|
query: query_params,
|
|
1265
1365
|
request_options: request_options
|
|
1266
1366
|
)
|
|
@@ -1310,7 +1410,7 @@ module Payabli
|
|
|
1310
1410
|
request = Payabli::Internal::JSON::Request.new(
|
|
1311
1411
|
base_url: request_options[:base_url],
|
|
1312
1412
|
method: "GET",
|
|
1313
|
-
path: "Query/transfers/#{params[:entry]}",
|
|
1413
|
+
path: "Query/transfers/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
1314
1414
|
query: query_params,
|
|
1315
1415
|
request_options: request_options
|
|
1316
1416
|
)
|
|
@@ -1360,7 +1460,7 @@ module Payabli
|
|
|
1360
1460
|
request = Payabli::Internal::JSON::Request.new(
|
|
1361
1461
|
base_url: request_options[:base_url],
|
|
1362
1462
|
method: "GET",
|
|
1363
|
-
path: "Query/transfers/org/#{params[:org_id]}",
|
|
1463
|
+
path: "Query/transfers/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
1364
1464
|
query: query_params,
|
|
1365
1465
|
request_options: request_options
|
|
1366
1466
|
)
|
|
@@ -1407,7 +1507,7 @@ module Payabli
|
|
|
1407
1507
|
request = Payabli::Internal::JSON::Request.new(
|
|
1408
1508
|
base_url: request_options[:base_url],
|
|
1409
1509
|
method: "GET",
|
|
1410
|
-
path: "Query/transfersOut/org/#{params[:org_id]}",
|
|
1510
|
+
path: "Query/transfersOut/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
1411
1511
|
query: query_params,
|
|
1412
1512
|
request_options: request_options
|
|
1413
1513
|
)
|
|
@@ -1454,7 +1554,7 @@ module Payabli
|
|
|
1454
1554
|
request = Payabli::Internal::JSON::Request.new(
|
|
1455
1555
|
base_url: request_options[:base_url],
|
|
1456
1556
|
method: "GET",
|
|
1457
|
-
path: "Query/transfersOut/#{params[:entry]}",
|
|
1557
|
+
path: "Query/transfersOut/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
1458
1558
|
query: query_params,
|
|
1459
1559
|
request_options: request_options
|
|
1460
1560
|
)
|
|
@@ -1502,7 +1602,7 @@ module Payabli
|
|
|
1502
1602
|
request = Payabli::Internal::JSON::Request.new(
|
|
1503
1603
|
base_url: request_options[:base_url],
|
|
1504
1604
|
method: "GET",
|
|
1505
|
-
path: "Query/transferDetailsOut/#{params[:entry]}/#{params[:transfer_id]}",
|
|
1605
|
+
path: "Query/transferDetailsOut/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:transfer_id].to_s)}",
|
|
1506
1606
|
query: query_params,
|
|
1507
1607
|
request_options: request_options
|
|
1508
1608
|
)
|
|
@@ -1549,7 +1649,7 @@ module Payabli
|
|
|
1549
1649
|
request = Payabli::Internal::JSON::Request.new(
|
|
1550
1650
|
base_url: request_options[:base_url],
|
|
1551
1651
|
method: "GET",
|
|
1552
|
-
path: "Query/users/org/#{params[:org_id]}",
|
|
1652
|
+
path: "Query/users/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
1553
1653
|
query: query_params,
|
|
1554
1654
|
request_options: request_options
|
|
1555
1655
|
)
|
|
@@ -1596,7 +1696,7 @@ module Payabli
|
|
|
1596
1696
|
request = Payabli::Internal::JSON::Request.new(
|
|
1597
1697
|
base_url: request_options[:base_url],
|
|
1598
1698
|
method: "GET",
|
|
1599
|
-
path: "Query/users/point/#{params[:entry]}",
|
|
1699
|
+
path: "Query/users/point/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
1600
1700
|
query: query_params,
|
|
1601
1701
|
request_options: request_options
|
|
1602
1702
|
)
|
|
@@ -1646,7 +1746,7 @@ module Payabli
|
|
|
1646
1746
|
request = Payabli::Internal::JSON::Request.new(
|
|
1647
1747
|
base_url: request_options[:base_url],
|
|
1648
1748
|
method: "GET",
|
|
1649
|
-
path: "Query/vendors/#{params[:entry]}",
|
|
1749
|
+
path: "Query/vendors/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
1650
1750
|
query: query_params,
|
|
1651
1751
|
request_options: request_options
|
|
1652
1752
|
)
|
|
@@ -1696,7 +1796,7 @@ module Payabli
|
|
|
1696
1796
|
request = Payabli::Internal::JSON::Request.new(
|
|
1697
1797
|
base_url: request_options[:base_url],
|
|
1698
1798
|
method: "GET",
|
|
1699
|
-
path: "Query/vendors/org/#{params[:org_id]}",
|
|
1799
|
+
path: "Query/vendors/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
1700
1800
|
query: query_params,
|
|
1701
1801
|
request_options: request_options
|
|
1702
1802
|
)
|
|
@@ -1746,7 +1846,7 @@ module Payabli
|
|
|
1746
1846
|
request = Payabli::Internal::JSON::Request.new(
|
|
1747
1847
|
base_url: request_options[:base_url],
|
|
1748
1848
|
method: "GET",
|
|
1749
|
-
path: "Query/vcards/#{params[:entry]}",
|
|
1849
|
+
path: "Query/vcards/#{URI.encode_uri_component(params[:entry].to_s)}",
|
|
1750
1850
|
query: query_params,
|
|
1751
1851
|
request_options: request_options
|
|
1752
1852
|
)
|
|
@@ -1796,7 +1896,7 @@ module Payabli
|
|
|
1796
1896
|
request = Payabli::Internal::JSON::Request.new(
|
|
1797
1897
|
base_url: request_options[:base_url],
|
|
1798
1898
|
method: "GET",
|
|
1799
|
-
path: "Query/vcards/org/#{params[:org_id]}",
|
|
1899
|
+
path: "Query/vcards/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
1800
1900
|
query: query_params,
|
|
1801
1901
|
request_options: request_options
|
|
1802
1902
|
)
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Query
|
|
5
|
+
module Types
|
|
6
|
+
class ListPayoutSubscriptionsOrgRequest < Internal::Types::Model
|
|
7
|
+
field :org_id, -> { Integer }, optional: false, nullable: false, api_name: "orgId"
|
|
8
|
+
field :export_format, -> { Payabli::Types::ExportFormat }, optional: true, nullable: false, api_name: "exportFormat"
|
|
9
|
+
field :from_record, -> { Integer }, optional: true, nullable: false, api_name: "fromRecord"
|
|
10
|
+
field :limit_record, -> { Integer }, optional: true, nullable: false, api_name: "limitRecord"
|
|
11
|
+
field :parameters, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
|
|
12
|
+
field :sort_by, -> { String }, optional: true, nullable: false, api_name: "sortBy"
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Query
|
|
5
|
+
module Types
|
|
6
|
+
class ListPayoutSubscriptionsRequest < Internal::Types::Model
|
|
7
|
+
field :entry, -> { String }, optional: false, nullable: false
|
|
8
|
+
field :export_format, -> { Payabli::Types::ExportFormat }, optional: true, nullable: false, api_name: "exportFormat"
|
|
9
|
+
field :from_record, -> { Integer }, optional: true, nullable: false, api_name: "fromRecord"
|
|
10
|
+
field :limit_record, -> { Integer }, optional: true, nullable: false, api_name: "limitRecord"
|
|
11
|
+
field :parameters, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
|
|
12
|
+
field :sort_by, -> { String }, optional: true, nullable: false, api_name: "sortBy"
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -41,7 +41,7 @@ module Payabli
|
|
|
41
41
|
request = Payabli::Internal::JSON::Request.new(
|
|
42
42
|
base_url: request_options[:base_url],
|
|
43
43
|
method: "GET",
|
|
44
|
-
path: "Statistic/basic/#{params[:mode]}/#{params[:freq]}/#{params[:level]}/#{params[:entry_id]}",
|
|
44
|
+
path: "Statistic/basic/#{URI.encode_uri_component(params[:mode].to_s)}/#{URI.encode_uri_component(params[:freq].to_s)}/#{URI.encode_uri_component(params[:level].to_s)}/#{URI.encode_uri_component(params[:entry_id].to_s)}",
|
|
45
45
|
query: query_params,
|
|
46
46
|
request_options: request_options
|
|
47
47
|
)
|
|
@@ -82,7 +82,7 @@ module Payabli
|
|
|
82
82
|
request = Payabli::Internal::JSON::Request.new(
|
|
83
83
|
base_url: request_options[:base_url],
|
|
84
84
|
method: "GET",
|
|
85
|
-
path: "Statistic/customerbasic/#{params[:mode]}/#{params[:freq]}/#{params[:customer_id]}",
|
|
85
|
+
path: "Statistic/customerbasic/#{URI.encode_uri_component(params[:mode].to_s)}/#{URI.encode_uri_component(params[:freq].to_s)}/#{URI.encode_uri_component(params[:customer_id].to_s)}",
|
|
86
86
|
query: query_params,
|
|
87
87
|
request_options: request_options
|
|
88
88
|
)
|
|
@@ -123,7 +123,7 @@ module Payabli
|
|
|
123
123
|
request = Payabli::Internal::JSON::Request.new(
|
|
124
124
|
base_url: request_options[:base_url],
|
|
125
125
|
method: "GET",
|
|
126
|
-
path: "Statistic/subscriptions/#{params[:interval]}/#{params[:level]}/#{params[:entry_id]}",
|
|
126
|
+
path: "Statistic/subscriptions/#{URI.encode_uri_component(params[:interval].to_s)}/#{URI.encode_uri_component(params[:level].to_s)}/#{URI.encode_uri_component(params[:entry_id].to_s)}",
|
|
127
127
|
query: query_params,
|
|
128
128
|
request_options: request_options
|
|
129
129
|
)
|
|
@@ -164,7 +164,7 @@ module Payabli
|
|
|
164
164
|
request = Payabli::Internal::JSON::Request.new(
|
|
165
165
|
base_url: request_options[:base_url],
|
|
166
166
|
method: "GET",
|
|
167
|
-
path: "Statistic/vendorbasic/#{params[:mode]}/#{params[:freq]}/#{params[:id_vendor]}",
|
|
167
|
+
path: "Statistic/vendorbasic/#{URI.encode_uri_component(params[:mode].to_s)}/#{URI.encode_uri_component(params[:freq].to_s)}/#{URI.encode_uri_component(params[:id_vendor].to_s)}",
|
|
168
168
|
query: query_params,
|
|
169
169
|
request_options: request_options
|
|
170
170
|
)
|
|
@@ -27,7 +27,7 @@ module Payabli
|
|
|
27
27
|
request = Payabli::Internal::JSON::Request.new(
|
|
28
28
|
base_url: request_options[:base_url],
|
|
29
29
|
method: "GET",
|
|
30
|
-
path: "Subscription/#{params[:sub_id]}",
|
|
30
|
+
path: "Subscription/#{URI.encode_uri_component(params[:sub_id].to_s)}",
|
|
31
31
|
request_options: request_options
|
|
32
32
|
)
|
|
33
33
|
begin
|
|
@@ -107,7 +107,7 @@ module Payabli
|
|
|
107
107
|
request = Payabli::Internal::JSON::Request.new(
|
|
108
108
|
base_url: request_options[:base_url],
|
|
109
109
|
method: "DELETE",
|
|
110
|
-
path: "Subscription/#{params[:sub_id]}",
|
|
110
|
+
path: "Subscription/#{URI.encode_uri_component(params[:sub_id].to_s)}",
|
|
111
111
|
request_options: request_options
|
|
112
112
|
)
|
|
113
113
|
begin
|
|
@@ -145,7 +145,7 @@ module Payabli
|
|
|
145
145
|
request = Payabli::Internal::JSON::Request.new(
|
|
146
146
|
base_url: request_options[:base_url],
|
|
147
147
|
method: "PUT",
|
|
148
|
-
path: "Subscription/#{params[:sub_id]}",
|
|
148
|
+
path: "Subscription/#{URI.encode_uri_component(params[:sub_id].to_s)}",
|
|
149
149
|
body: body,
|
|
150
150
|
request_options: request_options
|
|
151
151
|
)
|
|
@@ -27,7 +27,7 @@ module Payabli
|
|
|
27
27
|
request = Payabli::Internal::JSON::Request.new(
|
|
28
28
|
base_url: request_options[:base_url],
|
|
29
29
|
method: "DELETE",
|
|
30
|
-
path: "Templates/#{params[:template_id]}",
|
|
30
|
+
path: "Templates/#{URI.encode_uri_component(params[:template_id].to_s)}",
|
|
31
31
|
request_options: request_options
|
|
32
32
|
)
|
|
33
33
|
begin
|
|
@@ -62,7 +62,7 @@ module Payabli
|
|
|
62
62
|
request = Payabli::Internal::JSON::Request.new(
|
|
63
63
|
base_url: request_options[:base_url],
|
|
64
64
|
method: "GET",
|
|
65
|
-
path: "Templates/getlink/#{params[:template_id]}/#{params[:ignore_empty]}",
|
|
65
|
+
path: "Templates/getlink/#{URI.encode_uri_component(params[:template_id].to_s)}/#{URI.encode_uri_component(params[:ignore_empty].to_s)}",
|
|
66
66
|
request_options: request_options
|
|
67
67
|
)
|
|
68
68
|
begin
|
|
@@ -96,7 +96,7 @@ module Payabli
|
|
|
96
96
|
request = Payabli::Internal::JSON::Request.new(
|
|
97
97
|
base_url: request_options[:base_url],
|
|
98
98
|
method: "GET",
|
|
99
|
-
path: "Templates/get/#{params[:template_id]}",
|
|
99
|
+
path: "Templates/get/#{URI.encode_uri_component(params[:template_id].to_s)}",
|
|
100
100
|
request_options: request_options
|
|
101
101
|
)
|
|
102
102
|
begin
|
|
@@ -144,7 +144,7 @@ module Payabli
|
|
|
144
144
|
request = Payabli::Internal::JSON::Request.new(
|
|
145
145
|
base_url: request_options[:base_url],
|
|
146
146
|
method: "GET",
|
|
147
|
-
path: "Query/templates/#{params[:org_id]}",
|
|
147
|
+
path: "Query/templates/#{URI.encode_uri_component(params[:org_id].to_s)}",
|
|
148
148
|
query: query_params,
|
|
149
149
|
request_options: request_options
|
|
150
150
|
)
|