subfi_pay 0.1.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 +7 -0
- data/Gemfile +11 -0
- data/Gemfile.lock +101 -0
- data/README.md +188 -0
- data/Rakefile +10 -0
- data/bin/console +11 -0
- data/docs/AccessKey.md +32 -0
- data/docs/AccessKeysApi.md +228 -0
- data/docs/AccountAttributes.md +20 -0
- data/docs/AccountAttributesAccount.md +20 -0
- data/docs/AccountCreateRequest.md +18 -0
- data/docs/AccountResponse.md +26 -0
- data/docs/AccountsApi.md +227 -0
- data/docs/BalanceTransactionAttributes.md +30 -0
- data/docs/BalanceTransactionResponse.md +38 -0
- data/docs/BalanceTransactionsApi.md +87 -0
- data/docs/BankAccountProfile.md +28 -0
- data/docs/BillingAddress.md +36 -0
- data/docs/CardProfile.md +42 -0
- data/docs/ChargeAttributes.md +26 -0
- data/docs/ChargeResponse.md +42 -0
- data/docs/ChargesApi.md +167 -0
- data/docs/ConnectedAccountAttributes.md +20 -0
- data/docs/ConnectedAccountResponse.md +26 -0
- data/docs/CreateAccountRequest.md +18 -0
- data/docs/CreateAccountRequestAccount.md +20 -0
- data/docs/CreateCustomerRequest.md +24 -0
- data/docs/CreateWebhookEndpointRequest.md +18 -0
- data/docs/CreateWebhookEndpointRequestWebhookEndpoint.md +28 -0
- data/docs/Customer.md +26 -0
- data/docs/CustomerAttributes.md +24 -0
- data/docs/CustomerAttributesCustomer.md +24 -0
- data/docs/CustomerCreateRequest.md +18 -0
- data/docs/CustomerUpdateAttributes.md +20 -0
- data/docs/CustomerUpdateAttributesCustomer.md +20 -0
- data/docs/CustomerUpdateRequest.md +18 -0
- data/docs/CustomersApi.md +307 -0
- data/docs/Event.md +30 -0
- data/docs/EventsApi.md +159 -0
- data/docs/ListAccessKeysResponse.md +20 -0
- data/docs/ListAccountsResponse.md +20 -0
- data/docs/ListBalanceTransactionsResponse.md +20 -0
- data/docs/ListChargesResponse.md +20 -0
- data/docs/ListCustomersResponse.md +20 -0
- data/docs/ListEventsResponse.md +20 -0
- data/docs/ListPaymentIntentsResponse.md +20 -0
- data/docs/ListPaymentMethodsResponse.md +20 -0
- data/docs/ListRefundsResponse.md +20 -0
- data/docs/ListWebhookEndpointsResponse.md +20 -0
- data/docs/ListWebhookRequestsResponse.md +20 -0
- data/docs/Meta.md +28 -0
- data/docs/PaymentIntentAttributes.md +26 -0
- data/docs/PaymentIntentAttributesPaymentIntent.md +26 -0
- data/docs/PaymentIntentCreateRequest.md +18 -0
- data/docs/PaymentIntentResponse.md +30 -0
- data/docs/PaymentIntentUpdateAttributes.md +18 -0
- data/docs/PaymentIntentUpdateAttributesPaymentIntent.md +18 -0
- data/docs/PaymentIntentsApi.md +533 -0
- data/docs/PaymentMethodAttributes.md +24 -0
- data/docs/PaymentMethodResponse.md +36 -0
- data/docs/PaymentMethodsApi.md +239 -0
- data/docs/RefundAttributes.md +20 -0
- data/docs/RefundResponse.md +30 -0
- data/docs/RefundsApi.md +311 -0
- data/docs/RollAccessKeyAttributes.md +18 -0
- data/docs/RollAccessKeyAttributesAccessKey.md +18 -0
- data/docs/RollAccessKeyRequest.md +18 -0
- data/docs/RollAccessKeyRequestAccessKey.md +18 -0
- data/docs/SubscriptionAttributes.md +30 -0
- data/docs/SubscriptionAttributesSubscription.md +30 -0
- data/docs/SubscriptionCreateRequest.md +18 -0
- data/docs/SubscriptionCreateRequestSubscription.md +30 -0
- data/docs/SubscriptionResponse.md +36 -0
- data/docs/SubscriptionsApi.md +155 -0
- data/docs/WebhookEndpoint.md +34 -0
- data/docs/WebhookEndpointsApi.md +380 -0
- data/docs/WebhookRequest.md +38 -0
- data/docs/WebhookRequestsApi.md +85 -0
- data/git_push.sh +57 -0
- data/lib/subfi_pay/api/access_keys_api.rb +235 -0
- data/lib/subfi_pay/api/accounts_api.rb +231 -0
- data/lib/subfi_pay/api/balance_transactions_api.rb +100 -0
- data/lib/subfi_pay/api/charges_api.rb +181 -0
- data/lib/subfi_pay/api/customers_api.rb +331 -0
- data/lib/subfi_pay/api/events_api.rb +172 -0
- data/lib/subfi_pay/api/payment_intents_api.rb +566 -0
- data/lib/subfi_pay/api/payment_methods_api.rb +262 -0
- data/lib/subfi_pay/api/refunds_api.rb +334 -0
- data/lib/subfi_pay/api/subscriptions_api.rb +177 -0
- data/lib/subfi_pay/api/webhook_endpoints_api.rb +404 -0
- data/lib/subfi_pay/api/webhook_requests_api.rb +97 -0
- data/lib/subfi_pay/api_client.rb +394 -0
- data/lib/subfi_pay/api_error.rb +58 -0
- data/lib/subfi_pay/configuration.rb +305 -0
- data/lib/subfi_pay/models/access_key.rb +275 -0
- data/lib/subfi_pay/models/account_attributes.rb +221 -0
- data/lib/subfi_pay/models/account_attributes_account.rb +221 -0
- data/lib/subfi_pay/models/account_create_request.rb +212 -0
- data/lib/subfi_pay/models/account_response.rb +248 -0
- data/lib/subfi_pay/models/balance_transaction_attributes.rb +266 -0
- data/lib/subfi_pay/models/balance_transaction_response.rb +303 -0
- data/lib/subfi_pay/models/bank_account_profile.rb +257 -0
- data/lib/subfi_pay/models/billing_address.rb +294 -0
- data/lib/subfi_pay/models/card_profile.rb +324 -0
- data/lib/subfi_pay/models/charge_attributes.rb +265 -0
- data/lib/subfi_pay/models/charge_response.rb +326 -0
- data/lib/subfi_pay/models/connected_account_attributes.rb +235 -0
- data/lib/subfi_pay/models/connected_account_response.rb +248 -0
- data/lib/subfi_pay/models/create_account_request.rb +219 -0
- data/lib/subfi_pay/models/create_account_request_account.rb +221 -0
- data/lib/subfi_pay/models/create_customer_request.rb +239 -0
- data/lib/subfi_pay/models/create_webhook_endpoint_request.rb +212 -0
- data/lib/subfi_pay/models/create_webhook_endpoint_request_webhook_endpoint.rb +257 -0
- data/lib/subfi_pay/models/customer.rb +248 -0
- data/lib/subfi_pay/models/customer_attributes.rb +239 -0
- data/lib/subfi_pay/models/customer_attributes_customer.rb +239 -0
- data/lib/subfi_pay/models/customer_create_request.rb +212 -0
- data/lib/subfi_pay/models/customer_update_attributes.rb +221 -0
- data/lib/subfi_pay/models/customer_update_attributes_customer.rb +221 -0
- data/lib/subfi_pay/models/customer_update_request.rb +212 -0
- data/lib/subfi_pay/models/event.rb +266 -0
- data/lib/subfi_pay/models/list_access_keys_response.rb +223 -0
- data/lib/subfi_pay/models/list_accounts_response.rb +223 -0
- data/lib/subfi_pay/models/list_balance_transactions_response.rb +223 -0
- data/lib/subfi_pay/models/list_charges_response.rb +223 -0
- data/lib/subfi_pay/models/list_customers_response.rb +223 -0
- data/lib/subfi_pay/models/list_events_response.rb +223 -0
- data/lib/subfi_pay/models/list_payment_intents_response.rb +223 -0
- data/lib/subfi_pay/models/list_payment_methods_response.rb +223 -0
- data/lib/subfi_pay/models/list_refunds_response.rb +223 -0
- data/lib/subfi_pay/models/list_webhook_endpoints_response.rb +223 -0
- data/lib/subfi_pay/models/list_webhook_requests_response.rb +223 -0
- data/lib/subfi_pay/models/meta.rb +259 -0
- data/lib/subfi_pay/models/payment_intent_attributes.rb +257 -0
- data/lib/subfi_pay/models/payment_intent_attributes_payment_intent.rb +257 -0
- data/lib/subfi_pay/models/payment_intent_create_request.rb +212 -0
- data/lib/subfi_pay/models/payment_intent_response.rb +268 -0
- data/lib/subfi_pay/models/payment_intent_update_attributes.rb +212 -0
- data/lib/subfi_pay/models/payment_intent_update_attributes_payment_intent.rb +214 -0
- data/lib/subfi_pay/models/payment_method_attributes.rb +246 -0
- data/lib/subfi_pay/models/payment_method_response.rb +296 -0
- data/lib/subfi_pay/models/refund_attributes.rb +228 -0
- data/lib/subfi_pay/models/refund_response.rb +268 -0
- data/lib/subfi_pay/models/roll_access_key_attributes.rb +212 -0
- data/lib/subfi_pay/models/roll_access_key_attributes_access_key.rb +219 -0
- data/lib/subfi_pay/models/roll_access_key_request.rb +212 -0
- data/lib/subfi_pay/models/roll_access_key_request_access_key.rb +219 -0
- data/lib/subfi_pay/models/subscription_attributes.rb +266 -0
- data/lib/subfi_pay/models/subscription_attributes_subscription.rb +266 -0
- data/lib/subfi_pay/models/subscription_create_request.rb +212 -0
- data/lib/subfi_pay/models/subscription_create_request_subscription.rb +266 -0
- data/lib/subfi_pay/models/subscription_response.rb +293 -0
- data/lib/subfi_pay/models/webhook_endpoint.rb +284 -0
- data/lib/subfi_pay/models/webhook_request.rb +302 -0
- data/lib/subfi_pay/version.rb +15 -0
- data/lib/subfi_pay.rb +99 -0
- data/run_fix_gemfile.sh +11 -0
- data/spec/api/access_keys_api_spec.rb +138 -0
- data/spec/api/accounts_api_spec.rb +145 -0
- data/spec/api/balance_transactions_api_spec.rb +86 -0
- data/spec/api/charges_api_spec.rb +121 -0
- data/spec/api/customers_api_spec.rb +134 -0
- data/spec/api/events_api_spec.rb +105 -0
- data/spec/api/payment_intents_api_spec.rb +250 -0
- data/spec/api/payment_methods_api_spec.rb +226 -0
- data/spec/api/refunds_api_spec.rb +158 -0
- data/spec/api/subscriptions_api_spec.rb +113 -0
- data/spec/api/webhook_endpoints_api_spec.rb +198 -0
- data/spec/api/webhook_requests_api_spec.rb +79 -0
- data/spec/configuration_spec.rb +23 -0
- data/spec/fixtures/access_keys/list_200.json +1 -0
- data/spec/fixtures/access_keys/roll_200.json +1 -0
- data/spec/fixtures/accounts/create_201.json +1 -0
- data/spec/fixtures/accounts/list_200.json +1 -0
- data/spec/fixtures/accounts/show_200.json +1 -0
- data/spec/fixtures/balance_transactions/list_200.json +69 -0
- data/spec/fixtures/charges/create_201.json +39 -0
- data/spec/fixtures/charges/list_200.json +1 -0
- data/spec/fixtures/charges/retrieve_200.json +1 -0
- data/spec/fixtures/customers/create_201.json +1 -0
- data/spec/fixtures/customers/list_200.json +1 -0
- data/spec/fixtures/customers/show_200.json +1 -0
- data/spec/fixtures/events/list_200.json +1 -0
- data/spec/fixtures/events/show_200.json +1 -0
- data/spec/fixtures/payment_intents/cancel_200.json +1 -0
- data/spec/fixtures/payment_intents/capture_200.json +1 -0
- data/spec/fixtures/payment_intents/confirm_200.json +1 -0
- data/spec/fixtures/payment_intents/create_201.json +1 -0
- data/spec/fixtures/payment_intents/fetch_200.json +1 -0
- data/spec/fixtures/payment_intents/list_200.json +1 -0
- data/spec/fixtures/payment_intents/update_200.json +1 -0
- data/spec/fixtures/payment_methods/create_bank_account_201.json +1 -0
- data/spec/fixtures/payment_methods/create_card_201.json +1 -0
- data/spec/fixtures/payment_methods/get_bank_account_200.json +29 -0
- data/spec/fixtures/payment_methods/get_card_200.json +1 -0
- data/spec/fixtures/payment_methods/list_200.json +1 -0
- data/spec/fixtures/refunds/create_201.json +1 -0
- data/spec/fixtures/refunds/list_200.json +1 -0
- data/spec/fixtures/refunds/show_200.json +1 -0
- data/spec/fixtures/subscriptions/create_201.json +1 -0
- data/spec/fixtures/subscriptions/show_200.json +1 -0
- data/spec/fixtures/webhook_endpoints/create_201.json +11 -0
- data/spec/fixtures/webhook_endpoints/list_200.json +1 -0
- data/spec/fixtures/webhook_endpoints/show_200.json +1 -0
- data/spec/fixtures/webhook_endpoints/update_200.json +13 -0
- data/spec/fixtures/webhook_requests/list_200.json +1 -0
- data/spec/models/access_key_spec.rb +39 -0
- data/spec/models/account_attributes_spec.rb +40 -0
- data/spec/models/account_create_request_spec.rb +38 -0
- data/spec/models/account_response_spec.rb +39 -0
- data/spec/models/balance_transaction_response_spec.rb +38 -0
- data/spec/models/bank_account_profile_spec.rb +38 -0
- data/spec/models/billing_address_spec.rb +38 -0
- data/spec/models/card_profile_spec.rb +38 -0
- data/spec/models/charge_attributes_spec.rb +45 -0
- data/spec/models/charge_response_spec.rb +45 -0
- data/spec/models/connected_account_attributes_spec.rb +38 -0
- data/spec/models/connected_account_response_spec.rb +39 -0
- data/spec/models/create_account_request_account_spec.rb +39 -0
- data/spec/models/create_account_request_spec.rb +39 -0
- data/spec/models/create_webhook_endpoint_request_spec.rb +38 -0
- data/spec/models/create_webhook_endpoint_request_webhook_endpoint_spec.rb +38 -0
- data/spec/models/customer_attributes_spec.rb +40 -0
- data/spec/models/customer_create_request_spec.rb +38 -0
- data/spec/models/customer_spec.rb +39 -0
- data/spec/models/customer_update_attributes_spec.rb +39 -0
- data/spec/models/customer_update_request_spec.rb +39 -0
- data/spec/models/event_spec.rb +39 -0
- data/spec/models/list_access_keys_response_spec.rb +38 -0
- data/spec/models/list_accounts_response_spec.rb +38 -0
- data/spec/models/list_balance_transactions_response_spec.rb +38 -0
- data/spec/models/list_charges_response_spec.rb +38 -0
- data/spec/models/list_customers_response_spec.rb +39 -0
- data/spec/models/list_events_response_spec.rb +38 -0
- data/spec/models/list_payment_intents_response_spec.rb +45 -0
- data/spec/models/list_payment_methods_response_spec.rb +39 -0
- data/spec/models/list_refunds_response_spec.rb +38 -0
- data/spec/models/list_webhook_endpoints_response_spec.rb +38 -0
- data/spec/models/list_webhook_requests_response_spec.rb +39 -0
- data/spec/models/meta_spec.rb +38 -0
- data/spec/models/payment_intent_attributes_spec.rb +44 -0
- data/spec/models/payment_intent_create_request_spec.rb +38 -0
- data/spec/models/payment_intent_response_spec.rb +45 -0
- data/spec/models/payment_intent_update_attributes_payment_intent_spec.rb +38 -0
- data/spec/models/payment_intent_update_attributes_spec.rb +37 -0
- data/spec/models/payment_method_attributes_spec.rb +38 -0
- data/spec/models/payment_method_response_spec.rb +38 -0
- data/spec/models/refund_attributes_spec.rb +39 -0
- data/spec/models/refund_response_spec.rb +38 -0
- data/spec/models/roll_access_key_attributes_access_key_spec.rb +39 -0
- data/spec/models/roll_access_key_attributes_spec.rb +40 -0
- data/spec/models/roll_access_key_request_access_key_spec.rb +38 -0
- data/spec/models/roll_access_key_request_spec.rb +37 -0
- data/spec/models/subscription_attributes_spec.rb +38 -0
- data/spec/models/subscription_create_request_spec.rb +40 -0
- data/spec/models/subscription_response_spec.rb +38 -0
- data/spec/models/webhook_endpoint_spec.rb +40 -0
- data/spec/models/webhook_request_spec.rb +40 -0
- data/spec/spec_helper.rb +123 -0
- data/subfi_pay.gemspec +39 -0
- metadata +444 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 5a1f2721715c4661d7cc4e497c4cf2e64ea59ef11cd194ab817dd2ecc1addd3f
|
4
|
+
data.tar.gz: 94a5cb434ff9d154033f788c0a3646fe7f1d139e8f10b95fb757fac6a6f9ec8d
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: dd82b92bd7cec8c36edbeac136007ecab7d1373c5205d374a60b1766d34fc50d62a59a9b3e0d73f3c90c98281949159696fe0027bb3e82f5947e4c33a9f496fc
|
7
|
+
data.tar.gz: 95b0c1cbd062a3f6fc60fe70cace564f6a6971034af60d21973bc0494161b1c16dbe44b74bd8fd9baca95cfad7cf58c018d0d6f35b1fea2c166d651c15c0dc53
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,101 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
subfi_pay (0.1.0)
|
5
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
addressable (2.8.7)
|
11
|
+
public_suffix (>= 2.0.2, < 7.0)
|
12
|
+
ast (2.4.2)
|
13
|
+
bigdecimal (3.1.8)
|
14
|
+
byebug (11.1.3)
|
15
|
+
coderay (1.1.3)
|
16
|
+
concurrent-ruby (1.3.3)
|
17
|
+
crack (1.0.0)
|
18
|
+
bigdecimal
|
19
|
+
rexml
|
20
|
+
diff-lcs (1.5.1)
|
21
|
+
ethon (0.16.0)
|
22
|
+
ffi (>= 1.15.0)
|
23
|
+
faker (3.4.1)
|
24
|
+
i18n (>= 1.8.11, < 2)
|
25
|
+
ffi (1.17.0-arm64-darwin)
|
26
|
+
ffi (1.17.0-x86_64-linux-gnu)
|
27
|
+
hashdiff (1.1.0)
|
28
|
+
i18n (1.14.5)
|
29
|
+
concurrent-ruby (~> 1.0)
|
30
|
+
json (2.9.1)
|
31
|
+
language_server-protocol (3.17.0.3)
|
32
|
+
method_source (1.1.0)
|
33
|
+
parallel (1.26.3)
|
34
|
+
parser (3.3.6.0)
|
35
|
+
ast (~> 2.4.1)
|
36
|
+
racc
|
37
|
+
pry (0.14.2)
|
38
|
+
coderay (~> 1.1)
|
39
|
+
method_source (~> 1.0)
|
40
|
+
pry-byebug (3.10.1)
|
41
|
+
byebug (~> 11.0)
|
42
|
+
pry (>= 0.13, < 0.15)
|
43
|
+
public_suffix (6.0.0)
|
44
|
+
racc (1.8.1)
|
45
|
+
rainbow (3.1.1)
|
46
|
+
rake (13.0.6)
|
47
|
+
regexp_parser (2.10.0)
|
48
|
+
rexml (3.3.1)
|
49
|
+
strscan
|
50
|
+
rspec (3.13.0)
|
51
|
+
rspec-core (~> 3.13.0)
|
52
|
+
rspec-expectations (~> 3.13.0)
|
53
|
+
rspec-mocks (~> 3.13.0)
|
54
|
+
rspec-core (3.13.0)
|
55
|
+
rspec-support (~> 3.13.0)
|
56
|
+
rspec-expectations (3.13.1)
|
57
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
58
|
+
rspec-support (~> 3.13.0)
|
59
|
+
rspec-mocks (3.13.1)
|
60
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
61
|
+
rspec-support (~> 3.13.0)
|
62
|
+
rspec-support (3.13.1)
|
63
|
+
rubocop (1.69.2)
|
64
|
+
json (~> 2.3)
|
65
|
+
language_server-protocol (>= 3.17.0)
|
66
|
+
parallel (~> 1.10)
|
67
|
+
parser (>= 3.3.0.2)
|
68
|
+
rainbow (>= 2.2.2, < 4.0)
|
69
|
+
regexp_parser (>= 2.9.3, < 3.0)
|
70
|
+
rubocop-ast (>= 1.36.2, < 2.0)
|
71
|
+
ruby-progressbar (~> 1.7)
|
72
|
+
unicode-display_width (>= 2.4.0, < 4.0)
|
73
|
+
rubocop-ast (1.37.0)
|
74
|
+
parser (>= 3.3.1.0)
|
75
|
+
ruby-progressbar (1.13.0)
|
76
|
+
strscan (3.1.0)
|
77
|
+
typhoeus (1.4.1)
|
78
|
+
ethon (>= 0.9.0)
|
79
|
+
unicode-display_width (3.1.3)
|
80
|
+
unicode-emoji (~> 4.0, >= 4.0.4)
|
81
|
+
unicode-emoji (4.0.4)
|
82
|
+
webmock (3.23.1)
|
83
|
+
addressable (>= 2.8.0)
|
84
|
+
crack (>= 0.3.2)
|
85
|
+
hashdiff (>= 0.4.0, < 2.0.0)
|
86
|
+
|
87
|
+
PLATFORMS
|
88
|
+
arm64-darwin
|
89
|
+
x86_64-linux
|
90
|
+
|
91
|
+
DEPENDENCIES
|
92
|
+
faker
|
93
|
+
pry-byebug
|
94
|
+
rake (~> 13.0.1)
|
95
|
+
rspec (~> 3.6, >= 3.6.0)
|
96
|
+
rubocop
|
97
|
+
subfi_pay!
|
98
|
+
webmock
|
99
|
+
|
100
|
+
BUNDLED WITH
|
101
|
+
2.5.15
|
data/README.md
ADDED
@@ -0,0 +1,188 @@
|
|
1
|
+
# subfi_pay
|
2
|
+
|
3
|
+
SubFiPay - the Ruby gem for the SubFi Pay API
|
4
|
+
|
5
|
+
API for SubFi Pay services
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 0.1.0
|
10
|
+
- Package version: 0.1.0
|
11
|
+
- Generator version: 7.7.0
|
12
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build subfi_pay.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./subfi_pay-0.1.0.gem
|
28
|
+
```
|
29
|
+
|
30
|
+
(for development, run `gem install --dev ./subfi_pay-0.1.0.gem` to install the development dependencies)
|
31
|
+
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
|
+
|
34
|
+
Finally add this to the Gemfile:
|
35
|
+
|
36
|
+
gem 'subfi_pay', '~> 0.1.0'
|
37
|
+
|
38
|
+
### Install from Git
|
39
|
+
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
41
|
+
|
42
|
+
gem 'subfi_pay', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
43
|
+
|
44
|
+
### Include the Ruby code directly
|
45
|
+
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
47
|
+
|
48
|
+
```shell
|
49
|
+
ruby -Ilib script.rb
|
50
|
+
```
|
51
|
+
|
52
|
+
## Getting Started
|
53
|
+
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# Load the gem
|
58
|
+
require 'subfi_pay'
|
59
|
+
|
60
|
+
# Setup authorization
|
61
|
+
SubFiPay.configure do |config|
|
62
|
+
# Configure API key authorization: ApiKeyAuth
|
63
|
+
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
64
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
65
|
+
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
66
|
+
end
|
67
|
+
|
68
|
+
api_instance = SubFiPay::AccessKeysApi.new
|
69
|
+
x_api_version = 'x_api_version_example' # String |
|
70
|
+
id = 'id_example' # String |
|
71
|
+
|
72
|
+
begin
|
73
|
+
#Delete an access key by ID
|
74
|
+
api_instance.delete_access_key(x_api_version, id)
|
75
|
+
rescue SubFiPay::ApiError => e
|
76
|
+
puts "Exception when calling AccessKeysApi->delete_access_key: #{e}"
|
77
|
+
end
|
78
|
+
|
79
|
+
```
|
80
|
+
|
81
|
+
## Documentation for API Endpoints
|
82
|
+
|
83
|
+
All URIs are relative to *https://pay-sandbox.subfi.com*
|
84
|
+
|
85
|
+
Class | Method | HTTP request | Description
|
86
|
+
------------ | ------------- | ------------- | -------------
|
87
|
+
*SubFiPay::AccessKeysApi* | [**delete_access_key**](docs/AccessKeysApi.md#delete_access_key) | **DELETE** /access_keys/{id} | Delete an access key by ID
|
88
|
+
*SubFiPay::AccessKeysApi* | [**list_access_keys**](docs/AccessKeysApi.md#list_access_keys) | **GET** /access_keys | List all access keys
|
89
|
+
*SubFiPay::AccessKeysApi* | [**roll_access_key**](docs/AccessKeysApi.md#roll_access_key) | **POST** /access_keys/{id}/roll | Roll an access key by ID
|
90
|
+
*SubFiPay::AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create a new account
|
91
|
+
*SubFiPay::AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **GET** /accounts/{id} | Retrieve an account by ID
|
92
|
+
*SubFiPay::AccountsApi* | [**list_accounts**](docs/AccountsApi.md#list_accounts) | **GET** /accounts | List all accounts
|
93
|
+
*SubFiPay::BalanceTransactionsApi* | [**list_balance_transactions**](docs/BalanceTransactionsApi.md#list_balance_transactions) | **GET** /balance_transactions | List all balance transactions
|
94
|
+
*SubFiPay::ChargesApi* | [**get_charge**](docs/ChargesApi.md#get_charge) | **GET** /charges/{id} | Retrieve a charge
|
95
|
+
*SubFiPay::ChargesApi* | [**list_charges**](docs/ChargesApi.md#list_charges) | **GET** /charges | List all charges
|
96
|
+
*SubFiPay::CustomersApi* | [**create_customer**](docs/CustomersApi.md#create_customer) | **POST** /customers | Create a new customer
|
97
|
+
*SubFiPay::CustomersApi* | [**get_customer**](docs/CustomersApi.md#get_customer) | **GET** /customers/{id} | Retrieve a customer by ID
|
98
|
+
*SubFiPay::CustomersApi* | [**list_customers**](docs/CustomersApi.md#list_customers) | **GET** /customers | List all customers
|
99
|
+
*SubFiPay::CustomersApi* | [**update_customer**](docs/CustomersApi.md#update_customer) | **PATCH** /customers/{id} | Update a customer by ID
|
100
|
+
*SubFiPay::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /events/{id} | Retrieve a single event by ID
|
101
|
+
*SubFiPay::EventsApi* | [**list_events**](docs/EventsApi.md#list_events) | **GET** /events | List all events
|
102
|
+
*SubFiPay::PaymentIntentsApi* | [**cancel_payment_intent**](docs/PaymentIntentsApi.md#cancel_payment_intent) | **POST** /payment_intents/{id}/cancel | Cancel a payment intent
|
103
|
+
*SubFiPay::PaymentIntentsApi* | [**capture_payment_intent**](docs/PaymentIntentsApi.md#capture_payment_intent) | **POST** /payment_intents/{id}/capture | Capture a payment intent
|
104
|
+
*SubFiPay::PaymentIntentsApi* | [**confirm_payment_intent**](docs/PaymentIntentsApi.md#confirm_payment_intent) | **POST** /payment_intents/{id}/confirm | Confirm a payment intent
|
105
|
+
*SubFiPay::PaymentIntentsApi* | [**create_payment_intent**](docs/PaymentIntentsApi.md#create_payment_intent) | **POST** /payment_intents | Create a new payment intent
|
106
|
+
*SubFiPay::PaymentIntentsApi* | [**get_payment_intent**](docs/PaymentIntentsApi.md#get_payment_intent) | **GET** /payment_intents/{id} | Retrieve a payment intent by ID
|
107
|
+
*SubFiPay::PaymentIntentsApi* | [**list_payment_intents**](docs/PaymentIntentsApi.md#list_payment_intents) | **GET** /payment_intents | List payment intents
|
108
|
+
*SubFiPay::PaymentIntentsApi* | [**update_payment_intent**](docs/PaymentIntentsApi.md#update_payment_intent) | **PATCH** /payment_intents/{id} | Update a payment intent
|
109
|
+
*SubFiPay::PaymentMethodsApi* | [**create_payment_method**](docs/PaymentMethodsApi.md#create_payment_method) | **POST** /payment_methods | Create a payment method
|
110
|
+
*SubFiPay::PaymentMethodsApi* | [**get_payment_method**](docs/PaymentMethodsApi.md#get_payment_method) | **GET** /payment_methods/{id} | Retrieve a payment method
|
111
|
+
*SubFiPay::PaymentMethodsApi* | [**list_payment_methods**](docs/PaymentMethodsApi.md#list_payment_methods) | **GET** /payment_methods | List all payment methods
|
112
|
+
*SubFiPay::RefundsApi* | [**cancel_refund**](docs/RefundsApi.md#cancel_refund) | **PUT** /refunds/{id}/cancel | Cancel a refund
|
113
|
+
*SubFiPay::RefundsApi* | [**create_refund**](docs/RefundsApi.md#create_refund) | **POST** /refunds | Create a refund
|
114
|
+
*SubFiPay::RefundsApi* | [**get_refund**](docs/RefundsApi.md#get_refund) | **GET** /refunds/{id} | Get a refund by ID
|
115
|
+
*SubFiPay::RefundsApi* | [**list_refunds**](docs/RefundsApi.md#list_refunds) | **GET** /refunds | List refunds for a Charge
|
116
|
+
*SubFiPay::SubscriptionsApi* | [**create_subscription**](docs/SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Create a new subscription
|
117
|
+
*SubFiPay::SubscriptionsApi* | [**get_subscription**](docs/SubscriptionsApi.md#get_subscription) | **GET** /subscriptions/{id} | Retrieve a subscription by ID
|
118
|
+
*SubFiPay::WebhookEndpointsApi* | [**create_webhook_endpoint**](docs/WebhookEndpointsApi.md#create_webhook_endpoint) | **POST** /webhook_endpoints | Create a webhook endpoint
|
119
|
+
*SubFiPay::WebhookEndpointsApi* | [**delete_webhook_endpoint**](docs/WebhookEndpointsApi.md#delete_webhook_endpoint) | **DELETE** /webhook_endpoints/{id} | Delete a webhook endpoint by ID
|
120
|
+
*SubFiPay::WebhookEndpointsApi* | [**get_webhook_endpoint**](docs/WebhookEndpointsApi.md#get_webhook_endpoint) | **GET** /webhook_endpoints/{id} | Retrieve a webhook endpoint by ID
|
121
|
+
*SubFiPay::WebhookEndpointsApi* | [**list_webhook_endpoints**](docs/WebhookEndpointsApi.md#list_webhook_endpoints) | **GET** /webhook_endpoints | List all webhook endpoints
|
122
|
+
*SubFiPay::WebhookEndpointsApi* | [**update_webhook_endpoint**](docs/WebhookEndpointsApi.md#update_webhook_endpoint) | **PATCH** /webhook_endpoints/{id} | Update a webhook endpoint by ID
|
123
|
+
*SubFiPay::WebhookRequestsApi* | [**list_webhook_requests**](docs/WebhookRequestsApi.md#list_webhook_requests) | **GET** /webhook_requests | List all webhook requests
|
124
|
+
|
125
|
+
|
126
|
+
## Documentation for Models
|
127
|
+
|
128
|
+
- [SubFiPay::AccessKey](docs/AccessKey.md)
|
129
|
+
- [SubFiPay::AccountAttributes](docs/AccountAttributes.md)
|
130
|
+
- [SubFiPay::AccountCreateRequest](docs/AccountCreateRequest.md)
|
131
|
+
- [SubFiPay::AccountResponse](docs/AccountResponse.md)
|
132
|
+
- [SubFiPay::BalanceTransactionResponse](docs/BalanceTransactionResponse.md)
|
133
|
+
- [SubFiPay::BankAccountProfile](docs/BankAccountProfile.md)
|
134
|
+
- [SubFiPay::BillingAddress](docs/BillingAddress.md)
|
135
|
+
- [SubFiPay::CardProfile](docs/CardProfile.md)
|
136
|
+
- [SubFiPay::ChargeAttributes](docs/ChargeAttributes.md)
|
137
|
+
- [SubFiPay::ChargeResponse](docs/ChargeResponse.md)
|
138
|
+
- [SubFiPay::ConnectedAccountAttributes](docs/ConnectedAccountAttributes.md)
|
139
|
+
- [SubFiPay::ConnectedAccountResponse](docs/ConnectedAccountResponse.md)
|
140
|
+
- [SubFiPay::CreateWebhookEndpointRequest](docs/CreateWebhookEndpointRequest.md)
|
141
|
+
- [SubFiPay::CreateWebhookEndpointRequestWebhookEndpoint](docs/CreateWebhookEndpointRequestWebhookEndpoint.md)
|
142
|
+
- [SubFiPay::Customer](docs/Customer.md)
|
143
|
+
- [SubFiPay::CustomerAttributes](docs/CustomerAttributes.md)
|
144
|
+
- [SubFiPay::CustomerCreateRequest](docs/CustomerCreateRequest.md)
|
145
|
+
- [SubFiPay::CustomerUpdateAttributes](docs/CustomerUpdateAttributes.md)
|
146
|
+
- [SubFiPay::CustomerUpdateRequest](docs/CustomerUpdateRequest.md)
|
147
|
+
- [SubFiPay::Event](docs/Event.md)
|
148
|
+
- [SubFiPay::ListAccessKeysResponse](docs/ListAccessKeysResponse.md)
|
149
|
+
- [SubFiPay::ListAccountsResponse](docs/ListAccountsResponse.md)
|
150
|
+
- [SubFiPay::ListBalanceTransactionsResponse](docs/ListBalanceTransactionsResponse.md)
|
151
|
+
- [SubFiPay::ListChargesResponse](docs/ListChargesResponse.md)
|
152
|
+
- [SubFiPay::ListCustomersResponse](docs/ListCustomersResponse.md)
|
153
|
+
- [SubFiPay::ListEventsResponse](docs/ListEventsResponse.md)
|
154
|
+
- [SubFiPay::ListPaymentIntentsResponse](docs/ListPaymentIntentsResponse.md)
|
155
|
+
- [SubFiPay::ListPaymentMethodsResponse](docs/ListPaymentMethodsResponse.md)
|
156
|
+
- [SubFiPay::ListRefundsResponse](docs/ListRefundsResponse.md)
|
157
|
+
- [SubFiPay::ListWebhookEndpointsResponse](docs/ListWebhookEndpointsResponse.md)
|
158
|
+
- [SubFiPay::ListWebhookRequestsResponse](docs/ListWebhookRequestsResponse.md)
|
159
|
+
- [SubFiPay::Meta](docs/Meta.md)
|
160
|
+
- [SubFiPay::PaymentIntentAttributes](docs/PaymentIntentAttributes.md)
|
161
|
+
- [SubFiPay::PaymentIntentCreateRequest](docs/PaymentIntentCreateRequest.md)
|
162
|
+
- [SubFiPay::PaymentIntentResponse](docs/PaymentIntentResponse.md)
|
163
|
+
- [SubFiPay::PaymentIntentUpdateAttributes](docs/PaymentIntentUpdateAttributes.md)
|
164
|
+
- [SubFiPay::PaymentIntentUpdateAttributesPaymentIntent](docs/PaymentIntentUpdateAttributesPaymentIntent.md)
|
165
|
+
- [SubFiPay::PaymentMethodAttributes](docs/PaymentMethodAttributes.md)
|
166
|
+
- [SubFiPay::PaymentMethodResponse](docs/PaymentMethodResponse.md)
|
167
|
+
- [SubFiPay::RefundAttributes](docs/RefundAttributes.md)
|
168
|
+
- [SubFiPay::RefundResponse](docs/RefundResponse.md)
|
169
|
+
- [SubFiPay::RollAccessKeyAttributes](docs/RollAccessKeyAttributes.md)
|
170
|
+
- [SubFiPay::RollAccessKeyAttributesAccessKey](docs/RollAccessKeyAttributesAccessKey.md)
|
171
|
+
- [SubFiPay::SubscriptionAttributes](docs/SubscriptionAttributes.md)
|
172
|
+
- [SubFiPay::SubscriptionCreateRequest](docs/SubscriptionCreateRequest.md)
|
173
|
+
- [SubFiPay::SubscriptionResponse](docs/SubscriptionResponse.md)
|
174
|
+
- [SubFiPay::WebhookEndpoint](docs/WebhookEndpoint.md)
|
175
|
+
- [SubFiPay::WebhookRequest](docs/WebhookRequest.md)
|
176
|
+
|
177
|
+
|
178
|
+
## Documentation for Authorization
|
179
|
+
|
180
|
+
|
181
|
+
Authentication schemes defined for the API:
|
182
|
+
### ApiKeyAuth
|
183
|
+
|
184
|
+
|
185
|
+
- **Type**: API key
|
186
|
+
- **API key parameter name**: X-API-KEY
|
187
|
+
- **Location**: HTTP header
|
188
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require "bundler/setup"
|
5
|
+
require "subfi_pay"
|
6
|
+
|
7
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
8
|
+
# with your gem easier. You can also use a different console, if you like.
|
9
|
+
|
10
|
+
require "irb"
|
11
|
+
IRB.start(__FILE__)
|
data/docs/AccessKey.md
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
# SubFiPay::AccessKey
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **expires_at** | **Time** | | [optional] |
|
8
|
+
| **key** | **String** | | [optional] |
|
9
|
+
| **live** | **Boolean** | | [optional] |
|
10
|
+
| **type** | **String** | | [optional] |
|
11
|
+
| **can_roll** | **Boolean** | | [optional] |
|
12
|
+
| **created_at** | **Time** | | [optional] |
|
13
|
+
| **updated_at** | **Time** | | [optional] |
|
14
|
+
| **last_used_at** | **Time** | | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'subfi_pay'
|
20
|
+
|
21
|
+
instance = SubFiPay::AccessKey.new(
|
22
|
+
expires_at: null,
|
23
|
+
key: null,
|
24
|
+
live: null,
|
25
|
+
type: null,
|
26
|
+
can_roll: null,
|
27
|
+
created_at: null,
|
28
|
+
updated_at: null,
|
29
|
+
last_used_at: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,228 @@
|
|
1
|
+
# SubFiPay::AccessKeysApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pay-sandbox.subfi.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**delete_access_key**](AccessKeysApi.md#delete_access_key) | **DELETE** /access_keys/{id} | Delete an access key by ID |
|
8
|
+
| [**list_access_keys**](AccessKeysApi.md#list_access_keys) | **GET** /access_keys | List all access keys |
|
9
|
+
| [**roll_access_key**](AccessKeysApi.md#roll_access_key) | **POST** /access_keys/{id}/roll | Roll an access key by ID |
|
10
|
+
|
11
|
+
|
12
|
+
## delete_access_key
|
13
|
+
|
14
|
+
> delete_access_key(x_api_version, id)
|
15
|
+
|
16
|
+
Delete an access key by ID
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'subfi_pay'
|
23
|
+
# setup authorization
|
24
|
+
SubFiPay.configure do |config|
|
25
|
+
# Configure API key authorization: ApiKeyAuth
|
26
|
+
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = SubFiPay::AccessKeysApi.new
|
32
|
+
x_api_version = 'x_api_version_example' # String |
|
33
|
+
id = 'id_example' # String |
|
34
|
+
|
35
|
+
begin
|
36
|
+
# Delete an access key by ID
|
37
|
+
api_instance.delete_access_key(x_api_version, id)
|
38
|
+
rescue SubFiPay::ApiError => e
|
39
|
+
puts "Error when calling AccessKeysApi->delete_access_key: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
#### Using the delete_access_key_with_http_info variant
|
44
|
+
|
45
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
46
|
+
|
47
|
+
> <Array(nil, Integer, Hash)> delete_access_key_with_http_info(x_api_version, id)
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
begin
|
51
|
+
# Delete an access key by ID
|
52
|
+
data, status_code, headers = api_instance.delete_access_key_with_http_info(x_api_version, id)
|
53
|
+
p status_code # => 2xx
|
54
|
+
p headers # => { ... }
|
55
|
+
p data # => nil
|
56
|
+
rescue SubFiPay::ApiError => e
|
57
|
+
puts "Error when calling AccessKeysApi->delete_access_key_with_http_info: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
| Name | Type | Description | Notes |
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
65
|
+
| **x_api_version** | **String** | | |
|
66
|
+
| **id** | **String** | | |
|
67
|
+
|
68
|
+
### Return type
|
69
|
+
|
70
|
+
nil (empty response body)
|
71
|
+
|
72
|
+
### Authorization
|
73
|
+
|
74
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
75
|
+
|
76
|
+
### HTTP request headers
|
77
|
+
|
78
|
+
- **Content-Type**: Not defined
|
79
|
+
- **Accept**: Not defined
|
80
|
+
|
81
|
+
|
82
|
+
## list_access_keys
|
83
|
+
|
84
|
+
> <ListAccessKeysResponse> list_access_keys(x_api_version, opts)
|
85
|
+
|
86
|
+
List all access keys
|
87
|
+
|
88
|
+
### Examples
|
89
|
+
|
90
|
+
```ruby
|
91
|
+
require 'time'
|
92
|
+
require 'subfi_pay'
|
93
|
+
# setup authorization
|
94
|
+
SubFiPay.configure do |config|
|
95
|
+
# Configure API key authorization: ApiKeyAuth
|
96
|
+
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
97
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
98
|
+
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
99
|
+
end
|
100
|
+
|
101
|
+
api_instance = SubFiPay::AccessKeysApi.new
|
102
|
+
x_api_version = 'x_api_version_example' # String |
|
103
|
+
opts = {
|
104
|
+
page: 56, # Integer | The page of results to retrieve.
|
105
|
+
per_page: 56 # Integer | Number of results per page.
|
106
|
+
}
|
107
|
+
|
108
|
+
begin
|
109
|
+
# List all access keys
|
110
|
+
result = api_instance.list_access_keys(x_api_version, opts)
|
111
|
+
p result
|
112
|
+
rescue SubFiPay::ApiError => e
|
113
|
+
puts "Error when calling AccessKeysApi->list_access_keys: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
#### Using the list_access_keys_with_http_info variant
|
118
|
+
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
120
|
+
|
121
|
+
> <Array(<ListAccessKeysResponse>, Integer, Hash)> list_access_keys_with_http_info(x_api_version, opts)
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
begin
|
125
|
+
# List all access keys
|
126
|
+
data, status_code, headers = api_instance.list_access_keys_with_http_info(x_api_version, opts)
|
127
|
+
p status_code # => 2xx
|
128
|
+
p headers # => { ... }
|
129
|
+
p data # => <ListAccessKeysResponse>
|
130
|
+
rescue SubFiPay::ApiError => e
|
131
|
+
puts "Error when calling AccessKeysApi->list_access_keys_with_http_info: #{e}"
|
132
|
+
end
|
133
|
+
```
|
134
|
+
|
135
|
+
### Parameters
|
136
|
+
|
137
|
+
| Name | Type | Description | Notes |
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
139
|
+
| **x_api_version** | **String** | | |
|
140
|
+
| **page** | **Integer** | The page of results to retrieve. | [optional] |
|
141
|
+
| **per_page** | **Integer** | Number of results per page. | [optional] |
|
142
|
+
|
143
|
+
### Return type
|
144
|
+
|
145
|
+
[**ListAccessKeysResponse**](ListAccessKeysResponse.md)
|
146
|
+
|
147
|
+
### Authorization
|
148
|
+
|
149
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
150
|
+
|
151
|
+
### HTTP request headers
|
152
|
+
|
153
|
+
- **Content-Type**: Not defined
|
154
|
+
- **Accept**: application/json
|
155
|
+
|
156
|
+
|
157
|
+
## roll_access_key
|
158
|
+
|
159
|
+
> <AccessKey> roll_access_key(x_api_version, id, roll_access_key_attributes)
|
160
|
+
|
161
|
+
Roll an access key by ID
|
162
|
+
|
163
|
+
### Examples
|
164
|
+
|
165
|
+
```ruby
|
166
|
+
require 'time'
|
167
|
+
require 'subfi_pay'
|
168
|
+
# setup authorization
|
169
|
+
SubFiPay.configure do |config|
|
170
|
+
# Configure API key authorization: ApiKeyAuth
|
171
|
+
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
172
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
173
|
+
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
174
|
+
end
|
175
|
+
|
176
|
+
api_instance = SubFiPay::AccessKeysApi.new
|
177
|
+
x_api_version = 'x_api_version_example' # String |
|
178
|
+
id = 'id_example' # String |
|
179
|
+
roll_access_key_attributes = SubFiPay::RollAccessKeyAttributes.new # RollAccessKeyAttributes |
|
180
|
+
|
181
|
+
begin
|
182
|
+
# Roll an access key by ID
|
183
|
+
result = api_instance.roll_access_key(x_api_version, id, roll_access_key_attributes)
|
184
|
+
p result
|
185
|
+
rescue SubFiPay::ApiError => e
|
186
|
+
puts "Error when calling AccessKeysApi->roll_access_key: #{e}"
|
187
|
+
end
|
188
|
+
```
|
189
|
+
|
190
|
+
#### Using the roll_access_key_with_http_info variant
|
191
|
+
|
192
|
+
This returns an Array which contains the response data, status code and headers.
|
193
|
+
|
194
|
+
> <Array(<AccessKey>, Integer, Hash)> roll_access_key_with_http_info(x_api_version, id, roll_access_key_attributes)
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
begin
|
198
|
+
# Roll an access key by ID
|
199
|
+
data, status_code, headers = api_instance.roll_access_key_with_http_info(x_api_version, id, roll_access_key_attributes)
|
200
|
+
p status_code # => 2xx
|
201
|
+
p headers # => { ... }
|
202
|
+
p data # => <AccessKey>
|
203
|
+
rescue SubFiPay::ApiError => e
|
204
|
+
puts "Error when calling AccessKeysApi->roll_access_key_with_http_info: #{e}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
### Parameters
|
209
|
+
|
210
|
+
| Name | Type | Description | Notes |
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
212
|
+
| **x_api_version** | **String** | | |
|
213
|
+
| **id** | **String** | | |
|
214
|
+
| **roll_access_key_attributes** | [**RollAccessKeyAttributes**](RollAccessKeyAttributes.md) | | |
|
215
|
+
|
216
|
+
### Return type
|
217
|
+
|
218
|
+
[**AccessKey**](AccessKey.md)
|
219
|
+
|
220
|
+
### Authorization
|
221
|
+
|
222
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
223
|
+
|
224
|
+
### HTTP request headers
|
225
|
+
|
226
|
+
- **Content-Type**: application/json
|
227
|
+
- **Accept**: application/json
|
228
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SubFiPay::AccountAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **worldpay_merchant_id** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'subfi_pay'
|
14
|
+
|
15
|
+
instance = SubFiPay::AccountAttributes.new(
|
16
|
+
name: null,
|
17
|
+
worldpay_merchant_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SubFiPay::AccountAttributesAccount
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **worldpay_merchant_id** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'subfi_pay'
|
14
|
+
|
15
|
+
instance = SubFiPay::AccountAttributesAccount.new(
|
16
|
+
name: null,
|
17
|
+
worldpay_merchant_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# SubFiPay::AccountCreateRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account** | [**AccountAttributes**](AccountAttributes.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'subfi_pay'
|
13
|
+
|
14
|
+
instance = SubFiPay::AccountCreateRequest.new(
|
15
|
+
account: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# SubFiPay::AccountResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **active** | **Boolean** | | [optional] |
|
9
|
+
| **worldpay_merchant_id** | **String** | | [optional] |
|
10
|
+
| **created_at** | **Time** | | [optional] |
|
11
|
+
| **updated_at** | **Time** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'subfi_pay'
|
17
|
+
|
18
|
+
instance = SubFiPay::AccountResponse.new(
|
19
|
+
name: null,
|
20
|
+
active: null,
|
21
|
+
worldpay_merchant_id: null,
|
22
|
+
created_at: null,
|
23
|
+
updated_at: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|