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.
Files changed (187) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +1340 -0
  4. data/Rakefile +8 -0
  5. data/billabear.gemspec +38 -0
  6. data/docs/Address.md +13 -0
  7. data/docs/BillingAdmin.md +8 -0
  8. data/docs/CheckoutApi.md +61 -0
  9. data/docs/CheckoutBody.md +12 -0
  10. data/docs/CheckoutItems.md +11 -0
  11. data/docs/CheckoutSubscriptions.md +9 -0
  12. data/docs/Customer.md +18 -0
  13. data/docs/CustomersApi.md +904 -0
  14. data/docs/Error.md +8 -0
  15. data/docs/Feature.md +10 -0
  16. data/docs/FrontendToken.md +7 -0
  17. data/docs/InlineResponse200.md +9 -0
  18. data/docs/InlineResponse2001.md +9 -0
  19. data/docs/InlineResponse20010.md +9 -0
  20. data/docs/InlineResponse20011.md +7 -0
  21. data/docs/InlineResponse20012.md +8 -0
  22. data/docs/InlineResponse2002.md +9 -0
  23. data/docs/InlineResponse2003.md +9 -0
  24. data/docs/InlineResponse2004.md +9 -0
  25. data/docs/InlineResponse2005.md +9 -0
  26. data/docs/InlineResponse2006.md +9 -0
  27. data/docs/InlineResponse2007.md +9 -0
  28. data/docs/InlineResponse2007Data.md +14 -0
  29. data/docs/InlineResponse2007Receipts.md +9 -0
  30. data/docs/InlineResponse2008.md +9 -0
  31. data/docs/InlineResponse2009.md +9 -0
  32. data/docs/InlineResponse201.md +15 -0
  33. data/docs/InlineResponse201Lines.md +14 -0
  34. data/docs/InlineResponse400.md +7 -0
  35. data/docs/Invoice.md +21 -0
  36. data/docs/InvoiceLines.md +12 -0
  37. data/docs/InvoicesApi.md +169 -0
  38. data/docs/IssueRefundPayment.md +9 -0
  39. data/docs/Limit.md +8 -0
  40. data/docs/PaymentDetails.md +14 -0
  41. data/docs/PaymentDetailsApi.md +447 -0
  42. data/docs/PaymentsApi.md +399 -0
  43. data/docs/Price.md +14 -0
  44. data/docs/PricesApi.md +122 -0
  45. data/docs/Product.md +10 -0
  46. data/docs/ProductTaxType.md +9 -0
  47. data/docs/ProductsApi.md +228 -0
  48. data/docs/ReceiptApi.md +61 -0
  49. data/docs/Refund.md +16 -0
  50. data/docs/RefundsApi.md +181 -0
  51. data/docs/SeatsAddBody.md +7 -0
  52. data/docs/SeatsRemoveBody.md +7 -0
  53. data/docs/Subscription.md +18 -0
  54. data/docs/SubscriptionIdCancelBody.md +10 -0
  55. data/docs/SubscriptionIdExtendBody.md +7 -0
  56. data/docs/SubscriptionIdPlanBody.md +9 -0
  57. data/docs/SubscriptionIdPriceBody.md +8 -0
  58. data/docs/SubscriptionPlan.md +20 -0
  59. data/docs/SubscriptionStartBody.md +14 -0
  60. data/docs/SubscriptionTrialBody.md +10 -0
  61. data/docs/SubscriptionsApi.md +731 -0
  62. data/docs/VoucherCode.md +7 -0
  63. data/git_push.sh +55 -0
  64. data/lib/swagger_client/api/checkout_api.rb +78 -0
  65. data/lib/swagger_client/api/customers_api.rb +980 -0
  66. data/lib/swagger_client/api/invoices_api.rb +188 -0
  67. data/lib/swagger_client/api/payment_details_api.rb +494 -0
  68. data/lib/swagger_client/api/payments_api.rb +432 -0
  69. data/lib/swagger_client/api/prices_api.rb +146 -0
  70. data/lib/swagger_client/api/products_api.rb +249 -0
  71. data/lib/swagger_client/api/receipt_api.rb +76 -0
  72. data/lib/swagger_client/api/refunds_api.rb +200 -0
  73. data/lib/swagger_client/api/subscriptions_api.rb +812 -0
  74. data/lib/swagger_client/api_client.rb +388 -0
  75. data/lib/swagger_client/api_error.rb +57 -0
  76. data/lib/swagger_client/configuration.rb +205 -0
  77. data/lib/swagger_client/models/address.rb +265 -0
  78. data/lib/swagger_client/models/billing_admin.rb +215 -0
  79. data/lib/swagger_client/models/checkout_body.rb +265 -0
  80. data/lib/swagger_client/models/checkout_items.rb +242 -0
  81. data/lib/swagger_client/models/checkout_subscriptions.rb +224 -0
  82. data/lib/swagger_client/models/customer.rb +370 -0
  83. data/lib/swagger_client/models/error.rb +225 -0
  84. data/lib/swagger_client/models/feature.rb +240 -0
  85. data/lib/swagger_client/models/frontend_token.rb +211 -0
  86. data/lib/swagger_client/models/inline_response_200.rb +226 -0
  87. data/lib/swagger_client/models/inline_response_200_1.rb +228 -0
  88. data/lib/swagger_client/models/inline_response_200_10.rb +226 -0
  89. data/lib/swagger_client/models/inline_response_200_11.rb +206 -0
  90. data/lib/swagger_client/models/inline_response_200_12.rb +250 -0
  91. data/lib/swagger_client/models/inline_response_200_2.rb +226 -0
  92. data/lib/swagger_client/models/inline_response_200_3.rb +226 -0
  93. data/lib/swagger_client/models/inline_response_200_4.rb +226 -0
  94. data/lib/swagger_client/models/inline_response_200_5.rb +226 -0
  95. data/lib/swagger_client/models/inline_response_200_6.rb +226 -0
  96. data/lib/swagger_client/models/inline_response_200_7.rb +226 -0
  97. data/lib/swagger_client/models/inline_response_200_7_data.rb +307 -0
  98. data/lib/swagger_client/models/inline_response_200_7_receipts.rb +224 -0
  99. data/lib/swagger_client/models/inline_response_200_8.rb +226 -0
  100. data/lib/swagger_client/models/inline_response_200_9.rb +226 -0
  101. data/lib/swagger_client/models/inline_response_201.rb +285 -0
  102. data/lib/swagger_client/models/inline_response_201_lines.rb +269 -0
  103. data/lib/swagger_client/models/inline_response_400.rb +213 -0
  104. data/lib/swagger_client/models/invoice.rb +334 -0
  105. data/lib/swagger_client/models/invoice_lines.rb +251 -0
  106. data/lib/swagger_client/models/issue_refund_payment.rb +232 -0
  107. data/lib/swagger_client/models/limit.rb +215 -0
  108. data/lib/swagger_client/models/payment_details.rb +271 -0
  109. data/lib/swagger_client/models/price.rb +325 -0
  110. data/lib/swagger_client/models/product.rb +240 -0
  111. data/lib/swagger_client/models/product_tax_type.rb +229 -0
  112. data/lib/swagger_client/models/refund.rb +324 -0
  113. data/lib/swagger_client/models/seats_add_body.rb +211 -0
  114. data/lib/swagger_client/models/seats_remove_body.rb +211 -0
  115. data/lib/swagger_client/models/subscription.rb +305 -0
  116. data/lib/swagger_client/models/subscription_id_cancel_body.rb +294 -0
  117. data/lib/swagger_client/models/subscription_id_extend_body.rb +211 -0
  118. data/lib/swagger_client/models/subscription_id_plan_body.rb +270 -0
  119. data/lib/swagger_client/models/subscription_id_price_body.rb +259 -0
  120. data/lib/swagger_client/models/subscription_plan.rb +330 -0
  121. data/lib/swagger_client/models/subscription_start_body.rb +314 -0
  122. data/lib/swagger_client/models/subscription_trial_body.rb +242 -0
  123. data/lib/swagger_client/models/voucher_code.rb +211 -0
  124. data/lib/swagger_client/version.rb +14 -0
  125. data/lib/swagger_client.rb +95 -0
  126. data/spec/api/checkout_api_spec.rb +46 -0
  127. data/spec/api/customers_api_spec.rb +241 -0
  128. data/spec/api/invoices_api_spec.rb +70 -0
  129. data/spec/api/payment_details_api_spec.rb +134 -0
  130. data/spec/api/payments_api_spec.rb +124 -0
  131. data/spec/api/prices_api_spec.rb +61 -0
  132. data/spec/api/products_api_spec.rb +84 -0
  133. data/spec/api/receipt_api_spec.rb +46 -0
  134. data/spec/api/refunds_api_spec.rb +75 -0
  135. data/spec/api/subscriptions_api_spec.rb +200 -0
  136. data/spec/api_client_spec.rb +225 -0
  137. data/spec/base_object_spec.rb +109 -0
  138. data/spec/configuration_spec.rb +41 -0
  139. data/spec/models/address_spec.rb +76 -0
  140. data/spec/models/billing_admin_spec.rb +46 -0
  141. data/spec/models/checkout_body_spec.rb +70 -0
  142. data/spec/models/checkout_items_spec.rb +64 -0
  143. data/spec/models/checkout_subscriptions_spec.rb +52 -0
  144. data/spec/models/customer_spec.rb +114 -0
  145. data/spec/models/error_spec.rb +46 -0
  146. data/spec/models/feature_spec.rb +58 -0
  147. data/spec/models/frontend_token_spec.rb +40 -0
  148. data/spec/models/inline_response_200_10_spec.rb +52 -0
  149. data/spec/models/inline_response_200_11_spec.rb +40 -0
  150. data/spec/models/inline_response_200_12_spec.rb +50 -0
  151. data/spec/models/inline_response_200_1_spec.rb +52 -0
  152. data/spec/models/inline_response_200_2_spec.rb +52 -0
  153. data/spec/models/inline_response_200_3_spec.rb +52 -0
  154. data/spec/models/inline_response_200_4_spec.rb +52 -0
  155. data/spec/models/inline_response_200_5_spec.rb +52 -0
  156. data/spec/models/inline_response_200_6_spec.rb +52 -0
  157. data/spec/models/inline_response_200_7_data_spec.rb +86 -0
  158. data/spec/models/inline_response_200_7_receipts_spec.rb +52 -0
  159. data/spec/models/inline_response_200_7_spec.rb +52 -0
  160. data/spec/models/inline_response_200_8_spec.rb +52 -0
  161. data/spec/models/inline_response_200_9_spec.rb +52 -0
  162. data/spec/models/inline_response_200_spec.rb +52 -0
  163. data/spec/models/inline_response_201_lines_spec.rb +82 -0
  164. data/spec/models/inline_response_201_spec.rb +88 -0
  165. data/spec/models/inline_response_400_spec.rb +40 -0
  166. data/spec/models/invoice_lines_spec.rb +70 -0
  167. data/spec/models/invoice_spec.rb +124 -0
  168. data/spec/models/issue_refund_payment_spec.rb +52 -0
  169. data/spec/models/limit_spec.rb +46 -0
  170. data/spec/models/payment_details_spec.rb +82 -0
  171. data/spec/models/price_spec.rb +86 -0
  172. data/spec/models/product_spec.rb +58 -0
  173. data/spec/models/product_tax_type_spec.rb +52 -0
  174. data/spec/models/refund_spec.rb +98 -0
  175. data/spec/models/seats_add_body_spec.rb +40 -0
  176. data/spec/models/seats_remove_body_spec.rb +40 -0
  177. data/spec/models/subscription_id_cancel_body_spec.rb +66 -0
  178. data/spec/models/subscription_id_extend_body_spec.rb +40 -0
  179. data/spec/models/subscription_id_plan_body_spec.rb +56 -0
  180. data/spec/models/subscription_id_price_body_spec.rb +50 -0
  181. data/spec/models/subscription_plan_spec.rb +118 -0
  182. data/spec/models/subscription_spec.rb +106 -0
  183. data/spec/models/subscription_start_body_spec.rb +86 -0
  184. data/spec/models/subscription_trial_body_spec.rb +58 -0
  185. data/spec/models/voucher_code_spec.rb +40 -0
  186. data/spec/spec_helper.rb +110 -0
  187. metadata +349 -0
@@ -0,0 +1,904 @@
1
+ # SwaggerClient::CustomersApi
2
+
3
+ All URIs are relative to *https://{customerId}.billabear.cloud/api/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**add_seats_subscriptions**](CustomersApi.md#add_seats_subscriptions) | **POST** /subscription/{subscriptionId}/seats/add | Add Seats
8
+ [**apply_voucher_to_customer**](CustomersApi.md#apply_voucher_to_customer) | **POST** /customer/{customerId}/voucher | Apply voucher
9
+ [**create_customer**](CustomersApi.md#create_customer) | **POST** /customer | Create
10
+ [**disable_customer**](CustomersApi.md#disable_customer) | **POST** /customer/{customerId}/disable | Disable Customer
11
+ [**enable_customer**](CustomersApi.md#enable_customer) | **POST** /customer/{customerId}/enable | Enable Customer
12
+ [**get_active_for_customer**](CustomersApi.md#get_active_for_customer) | **GET** /customer/{customerId}/subscription/active | List Customer Active Subscriptions
13
+ [**get_all_customers**](CustomersApi.md#get_all_customers) | **GET** /customer | List
14
+ [**get_customer_by_id**](CustomersApi.md#get_customer_by_id) | **GET** /customer/{customerId} | Detail
15
+ [**get_customer_limits_by_id**](CustomersApi.md#get_customer_limits_by_id) | **GET** /customer/{customerId}/limits | Fetch Customer Limits
16
+ [**get_for_customer**](CustomersApi.md#get_for_customer) | **GET** /customer/{customerId}/subscription | List Customer Subscriptions
17
+ [**get_invoices_for_customer**](CustomersApi.md#get_invoices_for_customer) | **GET** /customer/{customerId}/invoices | List Customer Invoices
18
+ [**get_payments_for_customer**](CustomersApi.md#get_payments_for_customer) | **GET** /customer/{customerId}/payment | List Customer Payments
19
+ [**get_refunds_for_customer**](CustomersApi.md#get_refunds_for_customer) | **GET** /customer/{customerId}/refund | List Customer Refunds
20
+ [**list_payment_details**](CustomersApi.md#list_payment_details) | **GET** /customer/{customerId}/payment-methods | List Customer's Payment Details
21
+ [**remove_seats_subscriptions**](CustomersApi.md#remove_seats_subscriptions) | **POST** /subscription/{subscriptionId}/seats/remove | Remove Seats
22
+ [**update_customer**](CustomersApi.md#update_customer) | **PUT** /customer/{customerId} | Update
23
+
24
+ # **add_seats_subscriptions**
25
+ > InlineResponse20011 add_seats_subscriptions(bodysubscription_id)
26
+
27
+ Add Seats
28
+
29
+ Adds seats to a per seat subscription<br><br><strong>Since 1.1.4</strong>
30
+
31
+ ### Example
32
+ ```ruby
33
+ # load the gem
34
+ require 'swagger_client'
35
+ # setup authorization
36
+ SwaggerClient.configure do |config|
37
+ # Configure API key authorization: ApiKeyAuth
38
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
39
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
40
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
41
+ end
42
+
43
+ api_instance = SwaggerClient::CustomersApi.new
44
+ body = SwaggerClient::SeatsAddBody.new # SeatsAddBody |
45
+ subscription_id = 'subscription_id_example' # String | The id of the subscription to retrieve
46
+
47
+
48
+ begin
49
+ #Add Seats
50
+ result = api_instance.add_seats_subscriptions(bodysubscription_id)
51
+ p result
52
+ rescue SwaggerClient::ApiError => e
53
+ puts "Exception when calling CustomersApi->add_seats_subscriptions: #{e}"
54
+ end
55
+ ```
56
+
57
+ ### Parameters
58
+
59
+ Name | Type | Description | Notes
60
+ ------------- | ------------- | ------------- | -------------
61
+ **body** | [**SeatsAddBody**](SeatsAddBody.md)| |
62
+ **subscription_id** | **String**| The id of the subscription to retrieve |
63
+
64
+ ### Return type
65
+
66
+ [**InlineResponse20011**](InlineResponse20011.md)
67
+
68
+ ### Authorization
69
+
70
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: application/json
75
+ - **Accept**: application/json
76
+
77
+
78
+
79
+ # **apply_voucher_to_customer**
80
+ > String apply_voucher_to_customer(bodycustomer_id)
81
+
82
+ Apply voucher
83
+
84
+ Apply Voucher to Customer
85
+
86
+ ### Example
87
+ ```ruby
88
+ # load the gem
89
+ require 'swagger_client'
90
+ # setup authorization
91
+ SwaggerClient.configure do |config|
92
+ # Configure API key authorization: ApiKeyAuth
93
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
94
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
95
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
96
+ end
97
+
98
+ api_instance = SwaggerClient::CustomersApi.new
99
+ body = SwaggerClient::VoucherCode.new # VoucherCode |
100
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
101
+
102
+
103
+ begin
104
+ #Apply voucher
105
+ result = api_instance.apply_voucher_to_customer(bodycustomer_id)
106
+ p result
107
+ rescue SwaggerClient::ApiError => e
108
+ puts "Exception when calling CustomersApi->apply_voucher_to_customer: #{e}"
109
+ end
110
+ ```
111
+
112
+ ### Parameters
113
+
114
+ Name | Type | Description | Notes
115
+ ------------- | ------------- | ------------- | -------------
116
+ **body** | [**VoucherCode**](VoucherCode.md)| |
117
+ **customer_id** | **String**| The id of the customer to retrieve |
118
+
119
+ ### Return type
120
+
121
+ **String**
122
+
123
+ ### Authorization
124
+
125
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
126
+
127
+ ### HTTP request headers
128
+
129
+ - **Content-Type**: application/json
130
+ - **Accept**: application/json
131
+
132
+
133
+
134
+ # **create_customer**
135
+ > Customer create_customer(body)
136
+
137
+ Create
138
+
139
+ Create a customer
140
+
141
+ ### Example
142
+ ```ruby
143
+ # load the gem
144
+ require 'swagger_client'
145
+ # setup authorization
146
+ SwaggerClient.configure do |config|
147
+ # Configure API key authorization: ApiKeyAuth
148
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
149
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
150
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
151
+ end
152
+
153
+ api_instance = SwaggerClient::CustomersApi.new
154
+ body = SwaggerClient::Customer.new # Customer |
155
+
156
+
157
+ begin
158
+ #Create
159
+ result = api_instance.create_customer(body)
160
+ p result
161
+ rescue SwaggerClient::ApiError => e
162
+ puts "Exception when calling CustomersApi->create_customer: #{e}"
163
+ end
164
+ ```
165
+
166
+ ### Parameters
167
+
168
+ Name | Type | Description | Notes
169
+ ------------- | ------------- | ------------- | -------------
170
+ **body** | [**Customer**](Customer.md)| |
171
+
172
+ ### Return type
173
+
174
+ [**Customer**](Customer.md)
175
+
176
+ ### Authorization
177
+
178
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
179
+
180
+ ### HTTP request headers
181
+
182
+ - **Content-Type**: application/json
183
+ - **Accept**: application/json
184
+
185
+
186
+
187
+ # **disable_customer**
188
+ > String disable_customer(customer_id)
189
+
190
+ Disable Customer
191
+
192
+ Disable customer
193
+
194
+ ### Example
195
+ ```ruby
196
+ # load the gem
197
+ require 'swagger_client'
198
+ # setup authorization
199
+ SwaggerClient.configure do |config|
200
+ # Configure API key authorization: ApiKeyAuth
201
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
202
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
203
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
204
+ end
205
+
206
+ api_instance = SwaggerClient::CustomersApi.new
207
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
208
+
209
+
210
+ begin
211
+ #Disable Customer
212
+ result = api_instance.disable_customer(customer_id)
213
+ p result
214
+ rescue SwaggerClient::ApiError => e
215
+ puts "Exception when calling CustomersApi->disable_customer: #{e}"
216
+ end
217
+ ```
218
+
219
+ ### Parameters
220
+
221
+ Name | Type | Description | Notes
222
+ ------------- | ------------- | ------------- | -------------
223
+ **customer_id** | **String**| The id of the customer to retrieve |
224
+
225
+ ### Return type
226
+
227
+ **String**
228
+
229
+ ### Authorization
230
+
231
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: Not defined
236
+ - **Accept**: application/json
237
+
238
+
239
+
240
+ # **enable_customer**
241
+ > String enable_customer(customer_id)
242
+
243
+ Enable Customer
244
+
245
+ Enable a customer
246
+
247
+ ### Example
248
+ ```ruby
249
+ # load the gem
250
+ require 'swagger_client'
251
+ # setup authorization
252
+ SwaggerClient.configure do |config|
253
+ # Configure API key authorization: ApiKeyAuth
254
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
255
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
256
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
257
+ end
258
+
259
+ api_instance = SwaggerClient::CustomersApi.new
260
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
261
+
262
+
263
+ begin
264
+ #Enable Customer
265
+ result = api_instance.enable_customer(customer_id)
266
+ p result
267
+ rescue SwaggerClient::ApiError => e
268
+ puts "Exception when calling CustomersApi->enable_customer: #{e}"
269
+ end
270
+ ```
271
+
272
+ ### Parameters
273
+
274
+ Name | Type | Description | Notes
275
+ ------------- | ------------- | ------------- | -------------
276
+ **customer_id** | **String**| The id of the customer to retrieve |
277
+
278
+ ### Return type
279
+
280
+ **String**
281
+
282
+ ### Authorization
283
+
284
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
285
+
286
+ ### HTTP request headers
287
+
288
+ - **Content-Type**: Not defined
289
+ - **Accept**: application/json
290
+
291
+
292
+
293
+ # **get_active_for_customer**
294
+ > InlineResponse2006 get_active_for_customer(customer_id)
295
+
296
+ List Customer Active Subscriptions
297
+
298
+ List all Active customer subscriptions
299
+
300
+ ### Example
301
+ ```ruby
302
+ # load the gem
303
+ require 'swagger_client'
304
+ # setup authorization
305
+ SwaggerClient.configure do |config|
306
+ # Configure API key authorization: ApiKeyAuth
307
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
308
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
309
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
310
+ end
311
+
312
+ api_instance = SwaggerClient::CustomersApi.new
313
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
314
+
315
+
316
+ begin
317
+ #List Customer Active Subscriptions
318
+ result = api_instance.get_active_for_customer(customer_id)
319
+ p result
320
+ rescue SwaggerClient::ApiError => e
321
+ puts "Exception when calling CustomersApi->get_active_for_customer: #{e}"
322
+ end
323
+ ```
324
+
325
+ ### Parameters
326
+
327
+ Name | Type | Description | Notes
328
+ ------------- | ------------- | ------------- | -------------
329
+ **customer_id** | **String**| The id of the customer to retrieve |
330
+
331
+ ### Return type
332
+
333
+ [**InlineResponse2006**](InlineResponse2006.md)
334
+
335
+ ### Authorization
336
+
337
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
338
+
339
+ ### HTTP request headers
340
+
341
+ - **Content-Type**: Not defined
342
+ - **Accept**: application/json
343
+
344
+
345
+
346
+ # **get_all_customers**
347
+ > InlineResponse200 get_all_customers(opts)
348
+
349
+ List
350
+
351
+ List all customers
352
+
353
+ ### Example
354
+ ```ruby
355
+ # load the gem
356
+ require 'swagger_client'
357
+ # setup authorization
358
+ SwaggerClient.configure do |config|
359
+ # Configure API key authorization: ApiKeyAuth
360
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
361
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
362
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
363
+ end
364
+
365
+ api_instance = SwaggerClient::CustomersApi.new
366
+ opts = {
367
+ limit: 56, # Integer | How many items to return at one time (max 100)
368
+ last_key: 'last_key_example', # String | The key to be used in pagination to say what the last key of the previous page was
369
+ email: 'email_example', # String | The email to search for
370
+ country: 'country_example', # String | The country code to search for
371
+ reference: 'reference_example', # String | The reference to search for
372
+ external_reference: 'external_reference_example' # String | The external reference to search for
373
+ }
374
+
375
+ begin
376
+ #List
377
+ result = api_instance.get_all_customers(opts)
378
+ p result
379
+ rescue SwaggerClient::ApiError => e
380
+ puts "Exception when calling CustomersApi->get_all_customers: #{e}"
381
+ end
382
+ ```
383
+
384
+ ### Parameters
385
+
386
+ Name | Type | Description | Notes
387
+ ------------- | ------------- | ------------- | -------------
388
+ **limit** | **Integer**| How many items to return at one time (max 100) | [optional]
389
+ **last_key** | **String**| The key to be used in pagination to say what the last key of the previous page was | [optional]
390
+ **email** | **String**| The email to search for | [optional]
391
+ **country** | **String**| The country code to search for | [optional]
392
+ **reference** | **String**| The reference to search for | [optional]
393
+ **external_reference** | **String**| The external reference to search for | [optional]
394
+
395
+ ### Return type
396
+
397
+ [**InlineResponse200**](InlineResponse200.md)
398
+
399
+ ### Authorization
400
+
401
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
402
+
403
+ ### HTTP request headers
404
+
405
+ - **Content-Type**: Not defined
406
+ - **Accept**: application/json
407
+
408
+
409
+
410
+ # **get_customer_by_id**
411
+ > Customer get_customer_by_id(customer_id)
412
+
413
+ Detail
414
+
415
+ Info for a specific customer
416
+
417
+ ### Example
418
+ ```ruby
419
+ # load the gem
420
+ require 'swagger_client'
421
+ # setup authorization
422
+ SwaggerClient.configure do |config|
423
+ # Configure API key authorization: ApiKeyAuth
424
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
425
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
426
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
427
+ end
428
+
429
+ api_instance = SwaggerClient::CustomersApi.new
430
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
431
+
432
+
433
+ begin
434
+ #Detail
435
+ result = api_instance.get_customer_by_id(customer_id)
436
+ p result
437
+ rescue SwaggerClient::ApiError => e
438
+ puts "Exception when calling CustomersApi->get_customer_by_id: #{e}"
439
+ end
440
+ ```
441
+
442
+ ### Parameters
443
+
444
+ Name | Type | Description | Notes
445
+ ------------- | ------------- | ------------- | -------------
446
+ **customer_id** | **String**| The id of the customer to retrieve |
447
+
448
+ ### Return type
449
+
450
+ [**Customer**](Customer.md)
451
+
452
+ ### Authorization
453
+
454
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
455
+
456
+ ### HTTP request headers
457
+
458
+ - **Content-Type**: Not defined
459
+ - **Accept**: application/json
460
+
461
+
462
+
463
+ # **get_customer_limits_by_id**
464
+ > InlineResponse2001 get_customer_limits_by_id(customer_id)
465
+
466
+ Fetch Customer Limits
467
+
468
+ Limits for a specific customer
469
+
470
+ ### Example
471
+ ```ruby
472
+ # load the gem
473
+ require 'swagger_client'
474
+ # setup authorization
475
+ SwaggerClient.configure do |config|
476
+ # Configure API key authorization: ApiKeyAuth
477
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
478
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
479
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
480
+ end
481
+
482
+ api_instance = SwaggerClient::CustomersApi.new
483
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
484
+
485
+
486
+ begin
487
+ #Fetch Customer Limits
488
+ result = api_instance.get_customer_limits_by_id(customer_id)
489
+ p result
490
+ rescue SwaggerClient::ApiError => e
491
+ puts "Exception when calling CustomersApi->get_customer_limits_by_id: #{e}"
492
+ end
493
+ ```
494
+
495
+ ### Parameters
496
+
497
+ Name | Type | Description | Notes
498
+ ------------- | ------------- | ------------- | -------------
499
+ **customer_id** | **String**| The id of the customer to retrieve |
500
+
501
+ ### Return type
502
+
503
+ [**InlineResponse2001**](InlineResponse2001.md)
504
+
505
+ ### Authorization
506
+
507
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
508
+
509
+ ### HTTP request headers
510
+
511
+ - **Content-Type**: Not defined
512
+ - **Accept**: application/json
513
+
514
+
515
+
516
+ # **get_for_customer**
517
+ > InlineResponse2006 get_for_customer(customer_id)
518
+
519
+ List Customer Subscriptions
520
+
521
+ List all customer subscriptions<br><br><strong>Since 1.1</strong>
522
+
523
+ ### Example
524
+ ```ruby
525
+ # load the gem
526
+ require 'swagger_client'
527
+ # setup authorization
528
+ SwaggerClient.configure do |config|
529
+ # Configure API key authorization: ApiKeyAuth
530
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
531
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
532
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
533
+ end
534
+
535
+ api_instance = SwaggerClient::CustomersApi.new
536
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
537
+
538
+
539
+ begin
540
+ #List Customer Subscriptions
541
+ result = api_instance.get_for_customer(customer_id)
542
+ p result
543
+ rescue SwaggerClient::ApiError => e
544
+ puts "Exception when calling CustomersApi->get_for_customer: #{e}"
545
+ end
546
+ ```
547
+
548
+ ### Parameters
549
+
550
+ Name | Type | Description | Notes
551
+ ------------- | ------------- | ------------- | -------------
552
+ **customer_id** | **String**| The id of the customer to retrieve |
553
+
554
+ ### Return type
555
+
556
+ [**InlineResponse2006**](InlineResponse2006.md)
557
+
558
+ ### Authorization
559
+
560
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
561
+
562
+ ### HTTP request headers
563
+
564
+ - **Content-Type**: Not defined
565
+ - **Accept**: application/json
566
+
567
+
568
+
569
+ # **get_invoices_for_customer**
570
+ > InlineResponse2004 get_invoices_for_customer(customer_id)
571
+
572
+ List Customer Invoices
573
+
574
+ List Customer Invoices
575
+
576
+ ### Example
577
+ ```ruby
578
+ # load the gem
579
+ require 'swagger_client'
580
+ # setup authorization
581
+ SwaggerClient.configure do |config|
582
+ # Configure API key authorization: ApiKeyAuth
583
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
584
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
585
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
586
+ end
587
+
588
+ api_instance = SwaggerClient::CustomersApi.new
589
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
590
+
591
+
592
+ begin
593
+ #List Customer Invoices
594
+ result = api_instance.get_invoices_for_customer(customer_id)
595
+ p result
596
+ rescue SwaggerClient::ApiError => e
597
+ puts "Exception when calling CustomersApi->get_invoices_for_customer: #{e}"
598
+ end
599
+ ```
600
+
601
+ ### Parameters
602
+
603
+ Name | Type | Description | Notes
604
+ ------------- | ------------- | ------------- | -------------
605
+ **customer_id** | **String**| The id of the customer to retrieve |
606
+
607
+ ### Return type
608
+
609
+ [**InlineResponse2004**](InlineResponse2004.md)
610
+
611
+ ### Authorization
612
+
613
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
614
+
615
+ ### HTTP request headers
616
+
617
+ - **Content-Type**: Not defined
618
+ - **Accept**: application/json
619
+
620
+
621
+
622
+ # **get_payments_for_customer**
623
+ > InlineResponse2003 get_payments_for_customer(customer_id, opts)
624
+
625
+ List Customer Payments
626
+
627
+ List Customer Payment
628
+
629
+ ### Example
630
+ ```ruby
631
+ # load the gem
632
+ require 'swagger_client'
633
+ # setup authorization
634
+ SwaggerClient.configure do |config|
635
+ # Configure API key authorization: ApiKeyAuth
636
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
637
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
638
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
639
+ end
640
+
641
+ api_instance = SwaggerClient::CustomersApi.new
642
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
643
+ opts = {
644
+ limit: 56, # Integer | How many items to return at one time (max 100)
645
+ last_key: 'last_key_example', # String | The key to be used in pagination to say what the last key of the previous page was
646
+ name: 'name_example' # String | The name to search for
647
+ }
648
+
649
+ begin
650
+ #List Customer Payments
651
+ result = api_instance.get_payments_for_customer(customer_id, opts)
652
+ p result
653
+ rescue SwaggerClient::ApiError => e
654
+ puts "Exception when calling CustomersApi->get_payments_for_customer: #{e}"
655
+ end
656
+ ```
657
+
658
+ ### Parameters
659
+
660
+ Name | Type | Description | Notes
661
+ ------------- | ------------- | ------------- | -------------
662
+ **customer_id** | **String**| The id of the customer to retrieve |
663
+ **limit** | **Integer**| How many items to return at one time (max 100) | [optional]
664
+ **last_key** | **String**| The key to be used in pagination to say what the last key of the previous page was | [optional]
665
+ **name** | **String**| The name to search for | [optional]
666
+
667
+ ### Return type
668
+
669
+ [**InlineResponse2003**](InlineResponse2003.md)
670
+
671
+ ### Authorization
672
+
673
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
674
+
675
+ ### HTTP request headers
676
+
677
+ - **Content-Type**: Not defined
678
+ - **Accept**: application/json
679
+
680
+
681
+
682
+ # **get_refunds_for_customer**
683
+ > InlineResponse2002 get_refunds_for_customer(customer_id, opts)
684
+
685
+ List Customer Refunds
686
+
687
+ List Customer Refund
688
+
689
+ ### Example
690
+ ```ruby
691
+ # load the gem
692
+ require 'swagger_client'
693
+ # setup authorization
694
+ SwaggerClient.configure do |config|
695
+ # Configure API key authorization: ApiKeyAuth
696
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
697
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
698
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
699
+ end
700
+
701
+ api_instance = SwaggerClient::CustomersApi.new
702
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
703
+ opts = {
704
+ limit: 56, # Integer | How many items to return at one time (max 100)
705
+ last_key: 'last_key_example', # String | The key to be used in pagination to say what the last key of the previous page was
706
+ name: 'name_example' # String | The name to search for
707
+ }
708
+
709
+ begin
710
+ #List Customer Refunds
711
+ result = api_instance.get_refunds_for_customer(customer_id, opts)
712
+ p result
713
+ rescue SwaggerClient::ApiError => e
714
+ puts "Exception when calling CustomersApi->get_refunds_for_customer: #{e}"
715
+ end
716
+ ```
717
+
718
+ ### Parameters
719
+
720
+ Name | Type | Description | Notes
721
+ ------------- | ------------- | ------------- | -------------
722
+ **customer_id** | **String**| The id of the customer to retrieve |
723
+ **limit** | **Integer**| How many items to return at one time (max 100) | [optional]
724
+ **last_key** | **String**| The key to be used in pagination to say what the last key of the previous page was | [optional]
725
+ **name** | **String**| The name to search for | [optional]
726
+
727
+ ### Return type
728
+
729
+ [**InlineResponse2002**](InlineResponse2002.md)
730
+
731
+ ### Authorization
732
+
733
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
734
+
735
+ ### HTTP request headers
736
+
737
+ - **Content-Type**: Not defined
738
+ - **Accept**: application/json
739
+
740
+
741
+
742
+ # **list_payment_details**
743
+ > InlineResponse2005 list_payment_details(customer_id)
744
+
745
+ List Customer's Payment Details
746
+
747
+ List all customers <br><br>Added in version 1.1
748
+
749
+ ### Example
750
+ ```ruby
751
+ # load the gem
752
+ require 'swagger_client'
753
+ # setup authorization
754
+ SwaggerClient.configure do |config|
755
+ # Configure API key authorization: ApiKeyAuth
756
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
757
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
758
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
759
+ end
760
+
761
+ api_instance = SwaggerClient::CustomersApi.new
762
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
763
+
764
+
765
+ begin
766
+ #List Customer's Payment Details
767
+ result = api_instance.list_payment_details(customer_id)
768
+ p result
769
+ rescue SwaggerClient::ApiError => e
770
+ puts "Exception when calling CustomersApi->list_payment_details: #{e}"
771
+ end
772
+ ```
773
+
774
+ ### Parameters
775
+
776
+ Name | Type | Description | Notes
777
+ ------------- | ------------- | ------------- | -------------
778
+ **customer_id** | **String**| The id of the customer to retrieve |
779
+
780
+ ### Return type
781
+
782
+ [**InlineResponse2005**](InlineResponse2005.md)
783
+
784
+ ### Authorization
785
+
786
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
787
+
788
+ ### HTTP request headers
789
+
790
+ - **Content-Type**: Not defined
791
+ - **Accept**: application/json
792
+
793
+
794
+
795
+ # **remove_seats_subscriptions**
796
+ > InlineResponse20011 remove_seats_subscriptions(bodysubscription_id)
797
+
798
+ Remove Seats
799
+
800
+ Remove seats to a per seat subscription<br><br><strong>Since 1.1.4</strong>
801
+
802
+ ### Example
803
+ ```ruby
804
+ # load the gem
805
+ require 'swagger_client'
806
+ # setup authorization
807
+ SwaggerClient.configure do |config|
808
+ # Configure API key authorization: ApiKeyAuth
809
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
810
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
811
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
812
+ end
813
+
814
+ api_instance = SwaggerClient::CustomersApi.new
815
+ body = SwaggerClient::SeatsRemoveBody.new # SeatsRemoveBody |
816
+ subscription_id = 'subscription_id_example' # String | The id of the subscription to retrieve
817
+
818
+
819
+ begin
820
+ #Remove Seats
821
+ result = api_instance.remove_seats_subscriptions(bodysubscription_id)
822
+ p result
823
+ rescue SwaggerClient::ApiError => e
824
+ puts "Exception when calling CustomersApi->remove_seats_subscriptions: #{e}"
825
+ end
826
+ ```
827
+
828
+ ### Parameters
829
+
830
+ Name | Type | Description | Notes
831
+ ------------- | ------------- | ------------- | -------------
832
+ **body** | [**SeatsRemoveBody**](SeatsRemoveBody.md)| |
833
+ **subscription_id** | **String**| The id of the subscription to retrieve |
834
+
835
+ ### Return type
836
+
837
+ [**InlineResponse20011**](InlineResponse20011.md)
838
+
839
+ ### Authorization
840
+
841
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
842
+
843
+ ### HTTP request headers
844
+
845
+ - **Content-Type**: application/json
846
+ - **Accept**: application/json
847
+
848
+
849
+
850
+ # **update_customer**
851
+ > Customer update_customer(bodycustomer_id)
852
+
853
+ Update
854
+
855
+ Update a customer
856
+
857
+ ### Example
858
+ ```ruby
859
+ # load the gem
860
+ require 'swagger_client'
861
+ # setup authorization
862
+ SwaggerClient.configure do |config|
863
+ # Configure API key authorization: ApiKeyAuth
864
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
865
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
866
+ #config.api_key_prefix['X-API-Key'] = 'Bearer'
867
+ end
868
+
869
+ api_instance = SwaggerClient::CustomersApi.new
870
+ body = SwaggerClient::Customer.new # Customer |
871
+ customer_id = 'customer_id_example' # String | The id of the customer to retrieve
872
+
873
+
874
+ begin
875
+ #Update
876
+ result = api_instance.update_customer(bodycustomer_id)
877
+ p result
878
+ rescue SwaggerClient::ApiError => e
879
+ puts "Exception when calling CustomersApi->update_customer: #{e}"
880
+ end
881
+ ```
882
+
883
+ ### Parameters
884
+
885
+ Name | Type | Description | Notes
886
+ ------------- | ------------- | ------------- | -------------
887
+ **body** | [**Customer**](Customer.md)| |
888
+ **customer_id** | **String**| The id of the customer to retrieve |
889
+
890
+ ### Return type
891
+
892
+ [**Customer**](Customer.md)
893
+
894
+ ### Authorization
895
+
896
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
897
+
898
+ ### HTTP request headers
899
+
900
+ - **Content-Type**: application/json
901
+ - **Accept**: application/json
902
+
903
+
904
+