billabear 1.0.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 +9 -0
- data/README.md +1340 -0
- data/Rakefile +8 -0
- data/billabear.gemspec +38 -0
- data/docs/Address.md +13 -0
- data/docs/BillingAdmin.md +8 -0
- data/docs/CheckoutApi.md +61 -0
- data/docs/CheckoutBody.md +12 -0
- data/docs/CheckoutItems.md +11 -0
- data/docs/CheckoutSubscriptions.md +9 -0
- data/docs/Customer.md +18 -0
- data/docs/CustomersApi.md +904 -0
- data/docs/Error.md +8 -0
- data/docs/Feature.md +10 -0
- data/docs/FrontendToken.md +7 -0
- data/docs/InlineResponse200.md +9 -0
- data/docs/InlineResponse2001.md +9 -0
- data/docs/InlineResponse20010.md +9 -0
- data/docs/InlineResponse20011.md +7 -0
- data/docs/InlineResponse20012.md +8 -0
- data/docs/InlineResponse2002.md +9 -0
- data/docs/InlineResponse2003.md +9 -0
- data/docs/InlineResponse2004.md +9 -0
- data/docs/InlineResponse2005.md +9 -0
- data/docs/InlineResponse2006.md +9 -0
- data/docs/InlineResponse2007.md +9 -0
- data/docs/InlineResponse2007Data.md +14 -0
- data/docs/InlineResponse2007Receipts.md +9 -0
- data/docs/InlineResponse2008.md +9 -0
- data/docs/InlineResponse2009.md +9 -0
- data/docs/InlineResponse201.md +15 -0
- data/docs/InlineResponse201Lines.md +14 -0
- data/docs/InlineResponse400.md +7 -0
- data/docs/Invoice.md +21 -0
- data/docs/InvoiceLines.md +12 -0
- data/docs/InvoicesApi.md +169 -0
- data/docs/IssueRefundPayment.md +9 -0
- data/docs/Limit.md +8 -0
- data/docs/PaymentDetails.md +14 -0
- data/docs/PaymentDetailsApi.md +447 -0
- data/docs/PaymentsApi.md +399 -0
- data/docs/Price.md +14 -0
- data/docs/PricesApi.md +122 -0
- data/docs/Product.md +10 -0
- data/docs/ProductTaxType.md +9 -0
- data/docs/ProductsApi.md +228 -0
- data/docs/ReceiptApi.md +61 -0
- data/docs/Refund.md +16 -0
- data/docs/RefundsApi.md +181 -0
- data/docs/SeatsAddBody.md +7 -0
- data/docs/SeatsRemoveBody.md +7 -0
- data/docs/Subscription.md +18 -0
- data/docs/SubscriptionIdCancelBody.md +10 -0
- data/docs/SubscriptionIdExtendBody.md +7 -0
- data/docs/SubscriptionIdPlanBody.md +9 -0
- data/docs/SubscriptionIdPriceBody.md +8 -0
- data/docs/SubscriptionPlan.md +20 -0
- data/docs/SubscriptionStartBody.md +14 -0
- data/docs/SubscriptionTrialBody.md +10 -0
- data/docs/SubscriptionsApi.md +731 -0
- data/docs/VoucherCode.md +7 -0
- data/git_push.sh +55 -0
- data/lib/swagger_client/api/checkout_api.rb +78 -0
- data/lib/swagger_client/api/customers_api.rb +980 -0
- data/lib/swagger_client/api/invoices_api.rb +188 -0
- data/lib/swagger_client/api/payment_details_api.rb +494 -0
- data/lib/swagger_client/api/payments_api.rb +432 -0
- data/lib/swagger_client/api/prices_api.rb +146 -0
- data/lib/swagger_client/api/products_api.rb +249 -0
- data/lib/swagger_client/api/receipt_api.rb +76 -0
- data/lib/swagger_client/api/refunds_api.rb +200 -0
- data/lib/swagger_client/api/subscriptions_api.rb +812 -0
- data/lib/swagger_client/api_client.rb +388 -0
- data/lib/swagger_client/api_error.rb +57 -0
- data/lib/swagger_client/configuration.rb +205 -0
- data/lib/swagger_client/models/address.rb +265 -0
- data/lib/swagger_client/models/billing_admin.rb +215 -0
- data/lib/swagger_client/models/checkout_body.rb +265 -0
- data/lib/swagger_client/models/checkout_items.rb +242 -0
- data/lib/swagger_client/models/checkout_subscriptions.rb +224 -0
- data/lib/swagger_client/models/customer.rb +370 -0
- data/lib/swagger_client/models/error.rb +225 -0
- data/lib/swagger_client/models/feature.rb +240 -0
- data/lib/swagger_client/models/frontend_token.rb +211 -0
- data/lib/swagger_client/models/inline_response_200.rb +226 -0
- data/lib/swagger_client/models/inline_response_200_1.rb +228 -0
- data/lib/swagger_client/models/inline_response_200_10.rb +226 -0
- data/lib/swagger_client/models/inline_response_200_11.rb +206 -0
- data/lib/swagger_client/models/inline_response_200_12.rb +250 -0
- data/lib/swagger_client/models/inline_response_200_2.rb +226 -0
- data/lib/swagger_client/models/inline_response_200_3.rb +226 -0
- data/lib/swagger_client/models/inline_response_200_4.rb +226 -0
- data/lib/swagger_client/models/inline_response_200_5.rb +226 -0
- data/lib/swagger_client/models/inline_response_200_6.rb +226 -0
- data/lib/swagger_client/models/inline_response_200_7.rb +226 -0
- data/lib/swagger_client/models/inline_response_200_7_data.rb +307 -0
- data/lib/swagger_client/models/inline_response_200_7_receipts.rb +224 -0
- data/lib/swagger_client/models/inline_response_200_8.rb +226 -0
- data/lib/swagger_client/models/inline_response_200_9.rb +226 -0
- data/lib/swagger_client/models/inline_response_201.rb +285 -0
- data/lib/swagger_client/models/inline_response_201_lines.rb +269 -0
- data/lib/swagger_client/models/inline_response_400.rb +213 -0
- data/lib/swagger_client/models/invoice.rb +334 -0
- data/lib/swagger_client/models/invoice_lines.rb +251 -0
- data/lib/swagger_client/models/issue_refund_payment.rb +232 -0
- data/lib/swagger_client/models/limit.rb +215 -0
- data/lib/swagger_client/models/payment_details.rb +271 -0
- data/lib/swagger_client/models/price.rb +325 -0
- data/lib/swagger_client/models/product.rb +240 -0
- data/lib/swagger_client/models/product_tax_type.rb +229 -0
- data/lib/swagger_client/models/refund.rb +324 -0
- data/lib/swagger_client/models/seats_add_body.rb +211 -0
- data/lib/swagger_client/models/seats_remove_body.rb +211 -0
- data/lib/swagger_client/models/subscription.rb +305 -0
- data/lib/swagger_client/models/subscription_id_cancel_body.rb +294 -0
- data/lib/swagger_client/models/subscription_id_extend_body.rb +211 -0
- data/lib/swagger_client/models/subscription_id_plan_body.rb +270 -0
- data/lib/swagger_client/models/subscription_id_price_body.rb +259 -0
- data/lib/swagger_client/models/subscription_plan.rb +330 -0
- data/lib/swagger_client/models/subscription_start_body.rb +314 -0
- data/lib/swagger_client/models/subscription_trial_body.rb +242 -0
- data/lib/swagger_client/models/voucher_code.rb +211 -0
- data/lib/swagger_client/version.rb +14 -0
- data/lib/swagger_client.rb +95 -0
- data/spec/api/checkout_api_spec.rb +46 -0
- data/spec/api/customers_api_spec.rb +241 -0
- data/spec/api/invoices_api_spec.rb +70 -0
- data/spec/api/payment_details_api_spec.rb +134 -0
- data/spec/api/payments_api_spec.rb +124 -0
- data/spec/api/prices_api_spec.rb +61 -0
- data/spec/api/products_api_spec.rb +84 -0
- data/spec/api/receipt_api_spec.rb +46 -0
- data/spec/api/refunds_api_spec.rb +75 -0
- data/spec/api/subscriptions_api_spec.rb +200 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/address_spec.rb +76 -0
- data/spec/models/billing_admin_spec.rb +46 -0
- data/spec/models/checkout_body_spec.rb +70 -0
- data/spec/models/checkout_items_spec.rb +64 -0
- data/spec/models/checkout_subscriptions_spec.rb +52 -0
- data/spec/models/customer_spec.rb +114 -0
- data/spec/models/error_spec.rb +46 -0
- data/spec/models/feature_spec.rb +58 -0
- data/spec/models/frontend_token_spec.rb +40 -0
- data/spec/models/inline_response_200_10_spec.rb +52 -0
- data/spec/models/inline_response_200_11_spec.rb +40 -0
- data/spec/models/inline_response_200_12_spec.rb +50 -0
- data/spec/models/inline_response_200_1_spec.rb +52 -0
- data/spec/models/inline_response_200_2_spec.rb +52 -0
- data/spec/models/inline_response_200_3_spec.rb +52 -0
- data/spec/models/inline_response_200_4_spec.rb +52 -0
- data/spec/models/inline_response_200_5_spec.rb +52 -0
- data/spec/models/inline_response_200_6_spec.rb +52 -0
- data/spec/models/inline_response_200_7_data_spec.rb +86 -0
- data/spec/models/inline_response_200_7_receipts_spec.rb +52 -0
- data/spec/models/inline_response_200_7_spec.rb +52 -0
- data/spec/models/inline_response_200_8_spec.rb +52 -0
- data/spec/models/inline_response_200_9_spec.rb +52 -0
- data/spec/models/inline_response_200_spec.rb +52 -0
- data/spec/models/inline_response_201_lines_spec.rb +82 -0
- data/spec/models/inline_response_201_spec.rb +88 -0
- data/spec/models/inline_response_400_spec.rb +40 -0
- data/spec/models/invoice_lines_spec.rb +70 -0
- data/spec/models/invoice_spec.rb +124 -0
- data/spec/models/issue_refund_payment_spec.rb +52 -0
- data/spec/models/limit_spec.rb +46 -0
- data/spec/models/payment_details_spec.rb +82 -0
- data/spec/models/price_spec.rb +86 -0
- data/spec/models/product_spec.rb +58 -0
- data/spec/models/product_tax_type_spec.rb +52 -0
- data/spec/models/refund_spec.rb +98 -0
- data/spec/models/seats_add_body_spec.rb +40 -0
- data/spec/models/seats_remove_body_spec.rb +40 -0
- data/spec/models/subscription_id_cancel_body_spec.rb +66 -0
- data/spec/models/subscription_id_extend_body_spec.rb +40 -0
- data/spec/models/subscription_id_plan_body_spec.rb +56 -0
- data/spec/models/subscription_id_price_body_spec.rb +50 -0
- data/spec/models/subscription_plan_spec.rb +118 -0
- data/spec/models/subscription_spec.rb +106 -0
- data/spec/models/subscription_start_body_spec.rb +86 -0
- data/spec/models/subscription_trial_body_spec.rb +58 -0
- data/spec/models/voucher_code_spec.rb +40 -0
- data/spec/spec_helper.rb +110 -0
- metadata +349 -0
data/docs/Error.md
ADDED
data/docs/Feature.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# SwaggerClient::Feature
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | | [optional]
|
|
7
|
+
**name** | **String** | |
|
|
8
|
+
**code** | **String** | | [optional]
|
|
9
|
+
**description** | **String** | | [optional]
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse200
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<Customer>**](Customer.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2001
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**limits** | [**Array<Limit>**](Limit.md) | | [optional]
|
|
7
|
+
**features** | [**Array<Feature>**](Feature.md) | | [optional]
|
|
8
|
+
**user_count** | **Integer** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse20010
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<SubscriptionPlan>**](SubscriptionPlan.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2002
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<Refund>**](Refund.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2003
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<Paths1paymentgetresponses200contentapplication1jsonschemapropertiesdataitems>**](Paths1paymentgetresponses200contentapplication1jsonschemapropertiesdataitems.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2004
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<Invoice>**](Invoice.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2005
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<PaymentDetails>**](PaymentDetails.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2006
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<Subscription>**](Subscription.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2007
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<InlineResponse2007Data>**](InlineResponse2007Data.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2007Data
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | | [optional]
|
|
7
|
+
**amount** | **Integer** | | [optional]
|
|
8
|
+
**currency** | **String** | Three-letter ISO currency code. Must be upper-case | [optional]
|
|
9
|
+
**external_reference** | **String** | | [optional]
|
|
10
|
+
**status** | **String** | | [optional]
|
|
11
|
+
**created_at** | **String** | | [optional]
|
|
12
|
+
**customer** | [**Customer**](Customer.md) | | [optional]
|
|
13
|
+
**receipts** | [**Array<InlineResponse2007Receipts>**](InlineResponse2007Receipts.md) | | [optional]
|
|
14
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2007Receipts
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created_at** | **String** | | [optional]
|
|
7
|
+
**id** | **String** | | [optional]
|
|
8
|
+
**valid** | **BOOLEAN** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2008
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<Product>**](Product.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse2009
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**Array<Price>**](Price.md) | | [optional]
|
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
|
8
|
+
**last_key** | **String** | | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse201
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | [**Uuid**](Uuid.md) | |
|
|
7
|
+
**name** | **String** | | [optional]
|
|
8
|
+
**currency** | **String** | | [optional]
|
|
9
|
+
**customer** | [**Customer**](Customer.md) | | [optional]
|
|
10
|
+
**billing_admin** | [**BillingAdmin**](BillingAdmin.md) | | [optional]
|
|
11
|
+
**total** | **Integer** | | [optional]
|
|
12
|
+
**sub_total** | **Integer** | | [optional]
|
|
13
|
+
**tax_total** | **Integer** | | [optional]
|
|
14
|
+
**lines** | [**Array<InlineResponse201Lines>**](InlineResponse201Lines.md) | | [optional]
|
|
15
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# SwaggerClient::InlineResponse201Lines
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**subscription_plan** | [**SubscriptionPlan**](SubscriptionPlan.md) | | [optional]
|
|
7
|
+
**price** | [**Price**](Price.md) | | [optional]
|
|
8
|
+
**description** | **String** | | [optional]
|
|
9
|
+
**currency** | **String** | | [optional]
|
|
10
|
+
**seat_number** | **Integer** | | [optional]
|
|
11
|
+
**sub_total** | **Integer** | | [optional]
|
|
12
|
+
**tax_total** | **Integer** | | [optional]
|
|
13
|
+
**tax_rate** | [**BigDecimal**](BigDecimal.md) | | [optional]
|
|
14
|
+
|
data/docs/Invoice.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# SwaggerClient::Invoice
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | | [optional]
|
|
7
|
+
**number** | **String** | | [optional]
|
|
8
|
+
**currency** | **String** | | [optional]
|
|
9
|
+
**customer** | [**Customer**](Customer.md) | | [optional]
|
|
10
|
+
**tax_total** | **Integer** | | [optional]
|
|
11
|
+
**sub_total** | **Integer** | | [optional]
|
|
12
|
+
**amount_due** | **Integer** | | [optional]
|
|
13
|
+
**paid** | **BOOLEAN** | | [optional]
|
|
14
|
+
**pay_link** | **String** | | [optional]
|
|
15
|
+
**created_at** | **String** | | [optional]
|
|
16
|
+
**paid_at** | **String** | | [optional]
|
|
17
|
+
**due_date** | **String** | | [optional]
|
|
18
|
+
**biller_address** | [**Address**](Address.md) | | [optional]
|
|
19
|
+
**payeeaddress** | [**Address**](Address.md) | | [optional]
|
|
20
|
+
**lines** | [**Array<InvoiceLines>**](InvoiceLines.md) | | [optional]
|
|
21
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# SwaggerClient::InvoiceLines
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**description** | **String** | | [optional]
|
|
7
|
+
**currency** | **String** | | [optional]
|
|
8
|
+
**total** | **Integer** | | [optional]
|
|
9
|
+
**sub_total** | **Integer** | | [optional]
|
|
10
|
+
**tax_total** | **Integer** | | [optional]
|
|
11
|
+
**tax_rate** | [**BigDecimal**](BigDecimal.md) | | [optional]
|
|
12
|
+
|
data/docs/InvoicesApi.md
ADDED
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# SwaggerClient::InvoicesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://{customerId}.billabear.cloud/api/v1*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**charge_invoice**](InvoicesApi.md#charge_invoice) | **POST** /invoice/{invoiceId}/charge | Charge Invoice
|
|
8
|
+
[**download_invoice**](InvoicesApi.md#download_invoice) | **GET** /invoice/{invoiceId}/download | Download Invoice
|
|
9
|
+
[**get_invoices_for_customer**](InvoicesApi.md#get_invoices_for_customer) | **GET** /customer/{customerId}/invoices | List Customer Invoices
|
|
10
|
+
|
|
11
|
+
# **charge_invoice**
|
|
12
|
+
> InlineResponse20012 charge_invoice(invoice_id)
|
|
13
|
+
|
|
14
|
+
Charge Invoice
|
|
15
|
+
|
|
16
|
+
Attempts to charge a card that is on file for the invoice amount
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
```ruby
|
|
20
|
+
# load the gem
|
|
21
|
+
require 'swagger_client'
|
|
22
|
+
# setup authorization
|
|
23
|
+
SwaggerClient.configure do |config|
|
|
24
|
+
# Configure API key authorization: ApiKeyAuth
|
|
25
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
27
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
api_instance = SwaggerClient::InvoicesApi.new
|
|
31
|
+
invoice_id = 'invoice_id_example' # String | The id of the invoice
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
begin
|
|
35
|
+
#Charge Invoice
|
|
36
|
+
result = api_instance.charge_invoice(invoice_id)
|
|
37
|
+
p result
|
|
38
|
+
rescue SwaggerClient::ApiError => e
|
|
39
|
+
puts "Exception when calling InvoicesApi->charge_invoice: #{e}"
|
|
40
|
+
end
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
Name | Type | Description | Notes
|
|
46
|
+
------------- | ------------- | ------------- | -------------
|
|
47
|
+
**invoice_id** | **String**| The id of the invoice |
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
[**InlineResponse20012**](InlineResponse20012.md)
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: Not defined
|
|
60
|
+
- **Accept**: application/json
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
# **download_invoice**
|
|
65
|
+
> String download_invoice(invoice_id)
|
|
66
|
+
|
|
67
|
+
Download Invoice
|
|
68
|
+
|
|
69
|
+
Returns the pdf blob for the invoice
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
```ruby
|
|
73
|
+
# load the gem
|
|
74
|
+
require 'swagger_client'
|
|
75
|
+
# setup authorization
|
|
76
|
+
SwaggerClient.configure do |config|
|
|
77
|
+
# Configure API key authorization: ApiKeyAuth
|
|
78
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
79
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
80
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
api_instance = SwaggerClient::InvoicesApi.new
|
|
84
|
+
invoice_id = 'invoice_id_example' # String | The id of the invoice
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
begin
|
|
88
|
+
#Download Invoice
|
|
89
|
+
result = api_instance.download_invoice(invoice_id)
|
|
90
|
+
p result
|
|
91
|
+
rescue SwaggerClient::ApiError => e
|
|
92
|
+
puts "Exception when calling InvoicesApi->download_invoice: #{e}"
|
|
93
|
+
end
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
Name | Type | Description | Notes
|
|
99
|
+
------------- | ------------- | ------------- | -------------
|
|
100
|
+
**invoice_id** | **String**| The id of the invoice |
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
**String**
|
|
105
|
+
|
|
106
|
+
### Authorization
|
|
107
|
+
|
|
108
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
109
|
+
|
|
110
|
+
### HTTP request headers
|
|
111
|
+
|
|
112
|
+
- **Content-Type**: Not defined
|
|
113
|
+
- **Accept**: application/pdf
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
# **get_invoices_for_customer**
|
|
118
|
+
> InlineResponse2004 get_invoices_for_customer(customer_id)
|
|
119
|
+
|
|
120
|
+
List Customer Invoices
|
|
121
|
+
|
|
122
|
+
List Customer Invoices
|
|
123
|
+
|
|
124
|
+
### Example
|
|
125
|
+
```ruby
|
|
126
|
+
# load the gem
|
|
127
|
+
require 'swagger_client'
|
|
128
|
+
# setup authorization
|
|
129
|
+
SwaggerClient.configure do |config|
|
|
130
|
+
# Configure API key authorization: ApiKeyAuth
|
|
131
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
132
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
133
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
api_instance = SwaggerClient::InvoicesApi.new
|
|
137
|
+
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
begin
|
|
141
|
+
#List Customer Invoices
|
|
142
|
+
result = api_instance.get_invoices_for_customer(customer_id)
|
|
143
|
+
p result
|
|
144
|
+
rescue SwaggerClient::ApiError => e
|
|
145
|
+
puts "Exception when calling InvoicesApi->get_invoices_for_customer: #{e}"
|
|
146
|
+
end
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Parameters
|
|
150
|
+
|
|
151
|
+
Name | Type | Description | Notes
|
|
152
|
+
------------- | ------------- | ------------- | -------------
|
|
153
|
+
**customer_id** | **String**| The id of the customer to retrieve |
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: Not defined
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::IssueRefundPayment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**amount** | **Integer** | |
|
|
7
|
+
**currency** | **String** | Three-letter ISO currency code. Must be upper-case | [optional]
|
|
8
|
+
**reason** | **String** | | [optional]
|
|
9
|
+
|
data/docs/Limit.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# SwaggerClient::PaymentDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | | [optional]
|
|
7
|
+
**name** | **String** | | [optional]
|
|
8
|
+
**default** | **BOOLEAN** | | [optional]
|
|
9
|
+
**brand** | **String** | | [optional]
|
|
10
|
+
**last_four** | **String** | | [optional]
|
|
11
|
+
**expiry_month** | **String** | | [optional]
|
|
12
|
+
**expiry_year** | **String** | | [optional]
|
|
13
|
+
**created_at** | **String** | | [optional]
|
|
14
|
+
|