maxio-advanced-billing-sdk 6.1.0 → 7.0.1

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 (649) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +78 -65
  3. data/lib/advanced_billing/api_helper.rb +2 -2
  4. data/lib/advanced_billing/client.rb +5 -5
  5. data/lib/advanced_billing/configuration.rb +13 -10
  6. data/lib/advanced_billing/controllers/advance_invoice_controller.rb +12 -10
  7. data/lib/advanced_billing/controllers/api_exports_controller.rb +20 -20
  8. data/lib/advanced_billing/controllers/base_controller.rb +4 -10
  9. data/lib/advanced_billing/controllers/billing_portal_controller.rb +10 -10
  10. data/lib/advanced_billing/controllers/component_price_points_controller.rb +35 -34
  11. data/lib/advanced_billing/controllers/components_controller.rb +42 -36
  12. data/lib/advanced_billing/controllers/coupons_controller.rb +43 -38
  13. data/lib/advanced_billing/controllers/custom_fields_controller.rb +29 -25
  14. data/lib/advanced_billing/controllers/customers_controller.rb +22 -20
  15. data/lib/advanced_billing/controllers/events_based_billing_segments_controller.rb +22 -18
  16. data/lib/advanced_billing/controllers/events_controller.rb +8 -8
  17. data/lib/advanced_billing/controllers/insights_controller.rb +11 -11
  18. data/lib/advanced_billing/controllers/invoices_controller.rb +59 -92
  19. data/lib/advanced_billing/controllers/offers_controller.rb +14 -13
  20. data/lib/advanced_billing/controllers/payment_profiles_controller.rb +42 -40
  21. data/lib/advanced_billing/controllers/product_families_controller.rb +15 -14
  22. data/lib/advanced_billing/controllers/product_price_points_controller.rb +33 -32
  23. data/lib/advanced_billing/controllers/products_controller.rb +18 -16
  24. data/lib/advanced_billing/controllers/proforma_invoices_controller.rb +26 -23
  25. data/lib/advanced_billing/controllers/reason_codes_controller.rb +18 -16
  26. data/lib/advanced_billing/controllers/referral_codes_controller.rb +4 -4
  27. data/lib/advanced_billing/controllers/sales_commissions_controller.rb +8 -8
  28. data/lib/advanced_billing/controllers/sites_controller.rb +8 -8
  29. data/lib/advanced_billing/controllers/subscription_components_controller.rb +84 -59
  30. data/lib/advanced_billing/controllers/subscription_group_invoice_account_controller.rb +16 -14
  31. data/lib/advanced_billing/controllers/subscription_group_status_controller.rb +14 -14
  32. data/lib/advanced_billing/controllers/subscription_groups_controller.rb +28 -27
  33. data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb +68 -18
  34. data/lib/advanced_billing/controllers/subscription_notes_controller.rb +16 -14
  35. data/lib/advanced_billing/controllers/subscription_products_controller.rb +8 -8
  36. data/lib/advanced_billing/controllers/subscription_status_controller.rb +34 -28
  37. data/lib/advanced_billing/controllers/subscriptions_controller.rb +66 -93
  38. data/lib/advanced_billing/controllers/webhooks_controller.rb +45 -66
  39. data/lib/advanced_billing/exceptions/api_exception.rb +2 -2
  40. data/lib/advanced_billing/exceptions/component_allocation_error_exception.rb +7 -5
  41. data/lib/advanced_billing/exceptions/component_price_point_error_exception.rb +7 -5
  42. data/lib/advanced_billing/exceptions/customer_error_response_exception.rb +7 -5
  43. data/lib/advanced_billing/exceptions/error_array_map_response_exception.rb +7 -5
  44. data/lib/advanced_billing/exceptions/error_list_response_exception.rb +7 -5
  45. data/lib/advanced_billing/exceptions/error_string_map_response_exception.rb +7 -5
  46. data/lib/advanced_billing/exceptions/event_based_billing_list_segments_errors_exception.rb +7 -5
  47. data/lib/advanced_billing/exceptions/event_based_billing_segment_errors_exception.rb +7 -5
  48. data/lib/advanced_billing/exceptions/event_based_billing_segment_exception.rb +7 -5
  49. data/lib/advanced_billing/exceptions/product_price_point_error_response_exception.rb +7 -5
  50. data/lib/advanced_billing/exceptions/proforma_bad_request_error_response_exception.rb +7 -5
  51. data/lib/advanced_billing/exceptions/refund_prepayment_base_errors_response_exception.rb +7 -5
  52. data/lib/advanced_billing/exceptions/single_error_response_exception.rb +7 -5
  53. data/lib/advanced_billing/exceptions/single_string_error_response_exception.rb +7 -5
  54. data/lib/advanced_billing/exceptions/subscription_add_coupon_error_exception.rb +7 -5
  55. data/lib/advanced_billing/exceptions/subscription_component_allocation_error_exception.rb +7 -5
  56. data/lib/advanced_billing/exceptions/subscription_group_create_error_response_exception.rb +7 -5
  57. data/lib/advanced_billing/exceptions/subscription_group_signup_error_response_exception.rb +7 -5
  58. data/lib/advanced_billing/exceptions/subscription_group_update_error_response_exception.rb +7 -5
  59. data/lib/advanced_billing/exceptions/subscription_remove_coupon_errors_exception.rb +7 -5
  60. data/lib/advanced_billing/exceptions/subscription_response_error_exception.rb +7 -5
  61. data/lib/advanced_billing/exceptions/subscriptions_mrr_error_response_exception.rb +7 -5
  62. data/lib/advanced_billing/exceptions/too_many_management_link_requests_error_exception.rb +7 -5
  63. data/lib/advanced_billing/http/auth/basic_auth.rb +2 -2
  64. data/lib/advanced_billing/http/http_call_back.rb +2 -2
  65. data/lib/advanced_billing/http/http_method_enum.rb +2 -2
  66. data/lib/advanced_billing/http/http_request.rb +2 -2
  67. data/lib/advanced_billing/http/http_response.rb +2 -2
  68. data/lib/advanced_billing/http/proxy_settings.rb +13 -0
  69. data/lib/advanced_billing/models/account_balance.rb +2 -2
  70. data/lib/advanced_billing/models/account_balances.rb +2 -2
  71. data/lib/advanced_billing/models/ach_agreement.rb +2 -2
  72. data/lib/advanced_billing/models/activate_event_based_component.rb +2 -2
  73. data/lib/advanced_billing/models/activate_subscription_request.rb +2 -2
  74. data/lib/advanced_billing/models/add_coupons_request.rb +2 -2
  75. data/lib/advanced_billing/models/add_subscription_to_a_group.rb +2 -2
  76. data/lib/advanced_billing/models/address_change.rb +2 -2
  77. data/lib/advanced_billing/models/agreement_acceptance.rb +2 -2
  78. data/lib/advanced_billing/models/all_vaults.rb +2 -2
  79. data/lib/advanced_billing/models/allocate_components.rb +2 -2
  80. data/lib/advanced_billing/models/allocation.rb +2 -2
  81. data/lib/advanced_billing/models/allocation_expiration_date.rb +2 -2
  82. data/lib/advanced_billing/models/allocation_preview.rb +2 -2
  83. data/lib/advanced_billing/models/allocation_preview_direction.rb +2 -2
  84. data/lib/advanced_billing/models/allocation_preview_item.rb +2 -2
  85. data/lib/advanced_billing/models/allocation_preview_line_item.rb +2 -2
  86. data/lib/advanced_billing/models/allocation_preview_line_item_kind.rb +2 -2
  87. data/lib/advanced_billing/models/allocation_preview_response.rb +2 -2
  88. data/lib/advanced_billing/models/allocation_response.rb +2 -2
  89. data/lib/advanced_billing/models/allocation_settings.rb +2 -2
  90. data/lib/advanced_billing/models/apple_pay_payment_profile.rb +43 -5
  91. data/lib/advanced_billing/models/apple_pay_vault.rb +2 -2
  92. data/lib/advanced_billing/models/applied_credit_note_data.rb +2 -2
  93. data/lib/advanced_billing/models/apply_credit_note_event.rb +2 -2
  94. data/lib/advanced_billing/models/apply_credit_note_event_data.rb +2 -2
  95. data/lib/advanced_billing/models/apply_debit_note_event.rb +2 -2
  96. data/lib/advanced_billing/models/apply_debit_note_event_data.rb +2 -2
  97. data/lib/advanced_billing/models/apply_payment_event.rb +2 -2
  98. data/lib/advanced_billing/models/apply_payment_event_data.rb +2 -2
  99. data/lib/advanced_billing/models/attribute_error.rb +2 -2
  100. data/lib/advanced_billing/models/auto_invite.rb +2 -2
  101. data/lib/advanced_billing/models/auto_resume.rb +2 -2
  102. data/lib/advanced_billing/models/backport_invoice_event.rb +2 -2
  103. data/lib/advanced_billing/models/bank_account_attributes.rb +2 -2
  104. data/lib/advanced_billing/models/bank_account_holder_type.rb +2 -2
  105. data/lib/advanced_billing/models/bank_account_payment_profile.rb +42 -5
  106. data/lib/advanced_billing/models/bank_account_response.rb +2 -2
  107. data/lib/advanced_billing/models/bank_account_type.rb +2 -2
  108. data/lib/advanced_billing/models/bank_account_vault.rb +2 -2
  109. data/lib/advanced_billing/models/bank_account_verification.rb +2 -2
  110. data/lib/advanced_billing/models/bank_account_verification_request.rb +2 -2
  111. data/lib/advanced_billing/models/base_model.rb +2 -2
  112. data/lib/advanced_billing/models/base_refund_error.rb +2 -2
  113. data/lib/advanced_billing/models/base_string_error.rb +2 -2
  114. data/lib/advanced_billing/models/basic_date_field.rb +2 -2
  115. data/lib/advanced_billing/models/batch_job.rb +2 -2
  116. data/lib/advanced_billing/models/batch_job_response.rb +2 -2
  117. data/lib/advanced_billing/models/billing_manifest.rb +2 -2
  118. data/lib/advanced_billing/models/billing_manifest_item.rb +2 -2
  119. data/lib/advanced_billing/models/billing_manifest_line_item_kind.rb +2 -2
  120. data/lib/advanced_billing/models/billing_schedule.rb +2 -2
  121. data/lib/advanced_billing/models/breakouts.rb +2 -2
  122. data/lib/advanced_billing/models/bulk_components_price_point_assignment.rb +2 -2
  123. data/lib/advanced_billing/models/bulk_create_product_price_points_request.rb +2 -2
  124. data/lib/advanced_billing/models/bulk_create_product_price_points_response.rb +2 -2
  125. data/lib/advanced_billing/models/bulk_create_segments.rb +2 -2
  126. data/lib/advanced_billing/models/bulk_update_segments.rb +2 -2
  127. data/lib/advanced_billing/models/bulk_update_segments_item.rb +2 -2
  128. data/lib/advanced_billing/models/calendar_billing.rb +2 -2
  129. data/lib/advanced_billing/models/cancel_grouped_subscriptions_request.rb +2 -2
  130. data/lib/advanced_billing/models/cancellation_method.rb +2 -2
  131. data/lib/advanced_billing/models/cancellation_options.rb +2 -2
  132. data/lib/advanced_billing/models/cancellation_request.rb +2 -2
  133. data/lib/advanced_billing/models/card_type.rb +2 -2
  134. data/lib/advanced_billing/models/change_chargeback_status_event.rb +2 -2
  135. data/lib/advanced_billing/models/change_chargeback_status_event_data.rb +2 -2
  136. data/lib/advanced_billing/models/change_invoice_collection_method_event.rb +2 -2
  137. data/lib/advanced_billing/models/change_invoice_collection_method_event_data.rb +2 -2
  138. data/lib/advanced_billing/models/change_invoice_status_event.rb +2 -2
  139. data/lib/advanced_billing/models/change_invoice_status_event_data.rb +2 -2
  140. data/lib/advanced_billing/models/chargeback_status.rb +2 -2
  141. data/lib/advanced_billing/models/chargify_ebb.rb +2 -2
  142. data/lib/advanced_billing/models/cleanup_scope.rb +2 -2
  143. data/lib/advanced_billing/models/collection_method.rb +2 -2
  144. data/lib/advanced_billing/models/component.rb +25 -12
  145. data/lib/advanced_billing/models/component_allocation_change.rb +2 -2
  146. data/lib/advanced_billing/models/component_allocation_error_item.rb +2 -2
  147. data/lib/advanced_billing/models/component_cost_data.rb +2 -2
  148. data/lib/advanced_billing/models/component_cost_data_rate_tier.rb +2 -2
  149. data/lib/advanced_billing/models/component_currency_price.rb +2 -2
  150. data/lib/advanced_billing/models/component_currency_prices_response.rb +2 -2
  151. data/lib/advanced_billing/models/component_custom_price.rb +2 -2
  152. data/lib/advanced_billing/models/component_kind.rb +2 -2
  153. data/lib/advanced_billing/models/component_price.rb +2 -2
  154. data/lib/advanced_billing/models/component_price_point.rb +2 -2
  155. data/lib/advanced_billing/models/component_price_point_assignment.rb +2 -2
  156. data/lib/advanced_billing/models/component_price_point_error_item.rb +2 -2
  157. data/lib/advanced_billing/models/component_price_point_item.rb +2 -2
  158. data/lib/advanced_billing/models/component_price_point_response.rb +2 -2
  159. data/lib/advanced_billing/models/component_price_points_response.rb +2 -2
  160. data/lib/advanced_billing/models/component_response.rb +2 -2
  161. data/lib/advanced_billing/models/compounding_strategy.rb +2 -2
  162. data/lib/advanced_billing/models/consolidated_invoice.rb +2 -2
  163. data/lib/advanced_billing/models/count_response.rb +2 -2
  164. data/lib/advanced_billing/models/coupon.rb +2 -2
  165. data/lib/advanced_billing/models/coupon_currency.rb +2 -2
  166. data/lib/advanced_billing/models/coupon_currency_request.rb +2 -2
  167. data/lib/advanced_billing/models/coupon_currency_response.rb +2 -2
  168. data/lib/advanced_billing/models/coupon_payload.rb +2 -2
  169. data/lib/advanced_billing/models/coupon_request.rb +8 -6
  170. data/lib/advanced_billing/models/coupon_response.rb +2 -2
  171. data/lib/advanced_billing/models/coupon_restriction.rb +2 -2
  172. data/lib/advanced_billing/models/coupon_subcodes.rb +2 -2
  173. data/lib/advanced_billing/models/coupon_subcodes_response.rb +2 -2
  174. data/lib/advanced_billing/models/coupon_usage.rb +2 -2
  175. data/lib/advanced_billing/models/create_allocation.rb +2 -2
  176. data/lib/advanced_billing/models/create_allocation_request.rb +2 -2
  177. data/lib/advanced_billing/models/create_component_price_point.rb +2 -2
  178. data/lib/advanced_billing/models/create_component_price_point_request.rb +2 -2
  179. data/lib/advanced_billing/models/create_component_price_points_request.rb +2 -2
  180. data/lib/advanced_billing/models/create_credit_note_event.rb +2 -2
  181. data/lib/advanced_billing/models/create_currency_price.rb +2 -2
  182. data/lib/advanced_billing/models/create_currency_prices_request.rb +2 -2
  183. data/lib/advanced_billing/models/create_customer.rb +2 -2
  184. data/lib/advanced_billing/models/create_customer_request.rb +2 -2
  185. data/lib/advanced_billing/models/create_debit_note_event.rb +2 -2
  186. data/lib/advanced_billing/models/create_ebb_component.rb +2 -2
  187. data/lib/advanced_billing/models/create_invoice.rb +2 -2
  188. data/lib/advanced_billing/models/create_invoice_address.rb +2 -2
  189. data/lib/advanced_billing/models/create_invoice_coupon.rb +2 -2
  190. data/lib/advanced_billing/models/create_invoice_item.rb +2 -2
  191. data/lib/advanced_billing/models/create_invoice_payment.rb +2 -2
  192. data/lib/advanced_billing/models/create_invoice_payment_application.rb +2 -2
  193. data/lib/advanced_billing/models/create_invoice_payment_request.rb +2 -2
  194. data/lib/advanced_billing/models/create_invoice_request.rb +2 -2
  195. data/lib/advanced_billing/models/create_invoice_status.rb +2 -2
  196. data/lib/advanced_billing/models/create_metadata.rb +2 -2
  197. data/lib/advanced_billing/models/create_metadata_request.rb +2 -2
  198. data/lib/advanced_billing/models/create_metafield.rb +2 -2
  199. data/lib/advanced_billing/models/create_metafields_request.rb +2 -2
  200. data/lib/advanced_billing/models/create_metered_component.rb +2 -2
  201. data/lib/advanced_billing/models/create_multi_invoice_payment.rb +2 -2
  202. data/lib/advanced_billing/models/create_multi_invoice_payment_request.rb +2 -2
  203. data/lib/advanced_billing/models/create_offer.rb +2 -2
  204. data/lib/advanced_billing/models/create_offer_component.rb +2 -2
  205. data/lib/advanced_billing/models/create_offer_request.rb +2 -2
  206. data/lib/advanced_billing/models/create_on_off_component.rb +2 -2
  207. data/lib/advanced_billing/models/create_or_update_endpoint.rb +2 -2
  208. data/lib/advanced_billing/models/create_or_update_endpoint_request.rb +2 -2
  209. data/lib/advanced_billing/models/create_or_update_product.rb +2 -2
  210. data/lib/advanced_billing/models/create_or_update_product_request.rb +2 -2
  211. data/lib/advanced_billing/models/create_or_update_segment_price.rb +2 -2
  212. data/lib/advanced_billing/models/create_payment.rb +2 -2
  213. data/lib/advanced_billing/models/create_payment_profile.rb +2 -2
  214. data/lib/advanced_billing/models/create_payment_profile_request.rb +2 -2
  215. data/lib/advanced_billing/models/create_prepaid_component.rb +2 -2
  216. data/lib/advanced_billing/models/create_prepaid_usage_component_price_point.rb +2 -2
  217. data/lib/advanced_billing/models/create_prepayment.rb +2 -2
  218. data/lib/advanced_billing/models/create_prepayment_method.rb +2 -2
  219. data/lib/advanced_billing/models/create_prepayment_request.rb +2 -2
  220. data/lib/advanced_billing/models/create_prepayment_response.rb +2 -2
  221. data/lib/advanced_billing/models/create_product_currency_price.rb +2 -2
  222. data/lib/advanced_billing/models/create_product_currency_prices_request.rb +2 -2
  223. data/lib/advanced_billing/models/create_product_family.rb +2 -2
  224. data/lib/advanced_billing/models/create_product_family_request.rb +2 -2
  225. data/lib/advanced_billing/models/create_product_price_point.rb +2 -2
  226. data/lib/advanced_billing/models/create_product_price_point_request.rb +2 -2
  227. data/lib/advanced_billing/models/create_quantity_based_component.rb +2 -2
  228. data/lib/advanced_billing/models/create_reason_code.rb +2 -2
  229. data/lib/advanced_billing/models/create_reason_code_request.rb +2 -2
  230. data/lib/advanced_billing/models/create_segment.rb +2 -2
  231. data/lib/advanced_billing/models/create_segment_request.rb +2 -2
  232. data/lib/advanced_billing/models/create_signup_proforma_preview_include.rb +2 -2
  233. data/lib/advanced_billing/models/create_subscription.rb +43 -25
  234. data/lib/advanced_billing/models/create_subscription_component.rb +2 -2
  235. data/lib/advanced_billing/models/create_subscription_group.rb +2 -2
  236. data/lib/advanced_billing/models/create_subscription_group_request.rb +2 -2
  237. data/lib/advanced_billing/models/create_subscription_request.rb +2 -2
  238. data/lib/advanced_billing/models/create_usage.rb +2 -2
  239. data/lib/advanced_billing/models/create_usage_request.rb +2 -2
  240. data/lib/advanced_billing/models/created_prepayment.rb +2 -2
  241. data/lib/advanced_billing/models/credit_account_balance_changed.rb +2 -2
  242. data/lib/advanced_billing/models/credit_card_attributes.rb +2 -2
  243. data/lib/advanced_billing/models/credit_card_payment_profile.rb +43 -5
  244. data/lib/advanced_billing/models/credit_card_vault.rb +2 -2
  245. data/lib/advanced_billing/models/credit_note.rb +2 -2
  246. data/lib/advanced_billing/models/credit_note_application.rb +2 -2
  247. data/lib/advanced_billing/models/credit_note_line_item.rb +2 -2
  248. data/lib/advanced_billing/models/credit_note_status.rb +2 -2
  249. data/lib/advanced_billing/models/credit_scheme.rb +2 -2
  250. data/lib/advanced_billing/models/credit_scheme_request.rb +2 -2
  251. data/lib/advanced_billing/models/credit_type.rb +2 -2
  252. data/lib/advanced_billing/models/currency_price.rb +2 -2
  253. data/lib/advanced_billing/models/currency_price_role.rb +2 -2
  254. data/lib/advanced_billing/models/currency_prices_response.rb +2 -2
  255. data/lib/advanced_billing/models/custom_field_owner.rb +2 -2
  256. data/lib/advanced_billing/models/custom_field_value_change.rb +2 -2
  257. data/lib/advanced_billing/models/customer.rb +2 -2
  258. data/lib/advanced_billing/models/customer_attributes.rb +2 -2
  259. data/lib/advanced_billing/models/customer_change.rb +2 -2
  260. data/lib/advanced_billing/models/customer_changes_preview_response.rb +2 -2
  261. data/lib/advanced_billing/models/customer_custom_fields_change.rb +2 -2
  262. data/lib/advanced_billing/models/customer_error.rb +2 -2
  263. data/lib/advanced_billing/models/customer_payer_change.rb +2 -2
  264. data/lib/advanced_billing/models/customer_response.rb +2 -2
  265. data/lib/advanced_billing/models/debit_note.rb +2 -2
  266. data/lib/advanced_billing/models/debit_note_role.rb +2 -2
  267. data/lib/advanced_billing/models/debit_note_status.rb +2 -2
  268. data/lib/advanced_billing/models/deduct_service_credit.rb +2 -2
  269. data/lib/advanced_billing/models/deduct_service_credit_request.rb +2 -2
  270. data/lib/advanced_billing/models/delayed_cancellation_response.rb +2 -2
  271. data/lib/advanced_billing/models/delete_subscription_group_response.rb +2 -2
  272. data/lib/advanced_billing/models/direction.rb +2 -2
  273. data/lib/advanced_billing/models/discount_type.rb +2 -2
  274. data/lib/advanced_billing/models/dunner_data.rb +2 -2
  275. data/lib/advanced_billing/models/dunning_step_data.rb +2 -2
  276. data/lib/advanced_billing/models/dunning_step_reached.rb +2 -2
  277. data/lib/advanced_billing/models/ebb_component.rb +2 -2
  278. data/lib/advanced_billing/models/ebb_event.rb +2 -2
  279. data/lib/advanced_billing/models/enable_webhooks_request.rb +2 -2
  280. data/lib/advanced_billing/models/enable_webhooks_response.rb +2 -2
  281. data/lib/advanced_billing/models/endpoint.rb +2 -2
  282. data/lib/advanced_billing/models/endpoint_response.rb +2 -2
  283. data/lib/advanced_billing/models/errors.rb +2 -2
  284. data/lib/advanced_billing/models/event.rb +2 -2
  285. data/lib/advanced_billing/models/event_based_billing_segment_error.rb +2 -2
  286. data/lib/advanced_billing/models/event_key.rb +2 -2
  287. data/lib/advanced_billing/models/event_response.rb +2 -2
  288. data/lib/advanced_billing/models/expiration_interval_unit.rb +2 -2
  289. data/lib/advanced_billing/models/failed_payment_action.rb +2 -2
  290. data/lib/advanced_billing/models/failed_payment_event.rb +2 -2
  291. data/lib/advanced_billing/models/failed_payment_event_data.rb +2 -2
  292. data/lib/advanced_billing/models/first_charge_type.rb +2 -2
  293. data/lib/advanced_billing/models/full_subscription_group_response.rb +2 -2
  294. data/lib/advanced_billing/models/get_one_time_token_payment_profile.rb +2 -2
  295. data/lib/advanced_billing/models/get_one_time_token_request.rb +2 -2
  296. data/lib/advanced_billing/models/group_billing.rb +2 -2
  297. data/lib/advanced_billing/models/group_settings.rb +2 -2
  298. data/lib/advanced_billing/models/group_target.rb +2 -2
  299. data/lib/advanced_billing/models/group_target_type.rb +2 -2
  300. data/lib/advanced_billing/models/group_type.rb +2 -2
  301. data/lib/advanced_billing/models/historic_usage.rb +2 -2
  302. data/lib/advanced_billing/models/include_not_null.rb +2 -2
  303. data/lib/advanced_billing/models/include_null_or_not_null.rb +2 -2
  304. data/lib/advanced_billing/models/include_option.rb +2 -2
  305. data/lib/advanced_billing/models/interval_unit.rb +2 -2
  306. data/lib/advanced_billing/models/invoice.rb +2 -2
  307. data/lib/advanced_billing/models/invoice_address.rb +2 -2
  308. data/lib/advanced_billing/models/invoice_avatax_details.rb +2 -2
  309. data/lib/advanced_billing/models/invoice_balance_item.rb +2 -2
  310. data/lib/advanced_billing/models/invoice_consolidation_level.rb +2 -2
  311. data/lib/advanced_billing/models/invoice_credit.rb +2 -2
  312. data/lib/advanced_billing/models/invoice_custom_field.rb +2 -2
  313. data/lib/advanced_billing/models/invoice_customer.rb +2 -2
  314. data/lib/advanced_billing/models/invoice_date_field.rb +2 -2
  315. data/lib/advanced_billing/models/invoice_debit.rb +2 -2
  316. data/lib/advanced_billing/models/invoice_discount.rb +2 -2
  317. data/lib/advanced_billing/models/invoice_discount_breakout.rb +2 -2
  318. data/lib/advanced_billing/models/invoice_discount_source_type.rb +2 -2
  319. data/lib/advanced_billing/models/invoice_discount_type.rb +2 -2
  320. data/lib/advanced_billing/models/invoice_display_settings.rb +2 -2
  321. data/lib/advanced_billing/models/invoice_event_payment_method.rb +2 -2
  322. data/lib/advanced_billing/models/invoice_event_type.rb +2 -2
  323. data/lib/advanced_billing/models/invoice_issued.rb +2 -2
  324. data/lib/advanced_billing/models/invoice_line_item.rb +2 -2
  325. data/lib/advanced_billing/models/invoice_line_item_component_cost_data.rb +2 -2
  326. data/lib/advanced_billing/models/invoice_line_item_event_data.rb +2 -2
  327. data/lib/advanced_billing/models/invoice_line_item_pricing_detail.rb +2 -2
  328. data/lib/advanced_billing/models/invoice_payer.rb +2 -2
  329. data/lib/advanced_billing/models/invoice_payer_change.rb +2 -2
  330. data/lib/advanced_billing/models/invoice_payment.rb +2 -2
  331. data/lib/advanced_billing/models/invoice_payment_application.rb +2 -2
  332. data/lib/advanced_billing/models/invoice_payment_method.rb +2 -2
  333. data/lib/advanced_billing/models/invoice_payment_method_type.rb +2 -2
  334. data/lib/advanced_billing/models/invoice_payment_type.rb +2 -2
  335. data/lib/advanced_billing/models/invoice_pre_payment.rb +2 -2
  336. data/lib/advanced_billing/models/invoice_previous_balance.rb +2 -2
  337. data/lib/advanced_billing/models/invoice_refund.rb +2 -2
  338. data/lib/advanced_billing/models/invoice_response.rb +2 -2
  339. data/lib/advanced_billing/models/invoice_role.rb +2 -2
  340. data/lib/advanced_billing/models/invoice_seller.rb +2 -2
  341. data/lib/advanced_billing/models/invoice_sort_field.rb +2 -2
  342. data/lib/advanced_billing/models/invoice_status.rb +2 -2
  343. data/lib/advanced_billing/models/invoice_tax.rb +2 -2
  344. data/lib/advanced_billing/models/invoice_tax_breakout.rb +2 -2
  345. data/lib/advanced_billing/models/invoice_tax_component_breakout.rb +2 -2
  346. data/lib/advanced_billing/models/issue_advance_invoice_request.rb +2 -2
  347. data/lib/advanced_billing/models/issue_invoice_event.rb +2 -2
  348. data/lib/advanced_billing/models/issue_invoice_event_data.rb +2 -2
  349. data/lib/advanced_billing/models/issue_invoice_request.rb +2 -2
  350. data/lib/advanced_billing/models/issue_service_credit.rb +2 -2
  351. data/lib/advanced_billing/models/issue_service_credit_request.rb +2 -2
  352. data/lib/advanced_billing/models/item_category.rb +2 -2
  353. data/lib/advanced_billing/models/item_price_point_changed.rb +2 -2
  354. data/lib/advanced_billing/models/item_price_point_data.rb +2 -2
  355. data/lib/advanced_billing/models/line_item_kind.rb +2 -2
  356. data/lib/advanced_billing/models/line_item_transaction_type.rb +2 -2
  357. data/lib/advanced_billing/models/list_components_filter.rb +2 -2
  358. data/lib/advanced_billing/models/list_components_price_points_include.rb +2 -2
  359. data/lib/advanced_billing/models/list_components_price_points_response.rb +2 -2
  360. data/lib/advanced_billing/models/list_coupons_filter.rb +2 -2
  361. data/lib/advanced_billing/models/list_credit_notes_response.rb +2 -2
  362. data/lib/advanced_billing/models/list_events_date_field.rb +2 -2
  363. data/lib/advanced_billing/models/list_invoice_events_response.rb +2 -2
  364. data/lib/advanced_billing/models/list_invoices_response.rb +2 -2
  365. data/lib/advanced_billing/models/list_metafields_response.rb +2 -2
  366. data/lib/advanced_billing/models/list_mrr_filter.rb +2 -2
  367. data/lib/advanced_billing/models/list_mrr_response.rb +2 -2
  368. data/lib/advanced_billing/models/list_mrr_response_result.rb +2 -2
  369. data/lib/advanced_billing/models/list_offers_response.rb +2 -2
  370. data/lib/advanced_billing/models/list_prepayment_date_field.rb +2 -2
  371. data/lib/advanced_billing/models/list_prepayments_filter.rb +2 -2
  372. data/lib/advanced_billing/models/list_price_points_filter.rb +2 -2
  373. data/lib/advanced_billing/models/list_product_price_points_response.rb +2 -2
  374. data/lib/advanced_billing/models/list_products_filter.rb +2 -2
  375. data/lib/advanced_billing/models/list_products_include.rb +2 -2
  376. data/lib/advanced_billing/models/list_products_price_points_include.rb +2 -2
  377. data/lib/advanced_billing/models/list_proforma_invoices_meta.rb +2 -2
  378. data/lib/advanced_billing/models/list_proforma_invoices_response.rb +2 -2
  379. data/lib/advanced_billing/models/list_public_keys_meta.rb +2 -2
  380. data/lib/advanced_billing/models/list_public_keys_response.rb +2 -2
  381. data/lib/advanced_billing/models/list_sale_rep_item.rb +2 -2
  382. data/lib/advanced_billing/models/list_segments_filter.rb +2 -2
  383. data/lib/advanced_billing/models/list_segments_response.rb +2 -2
  384. data/lib/advanced_billing/models/list_service_credits_response.rb +82 -0
  385. data/lib/advanced_billing/models/list_subcription_group_prepayment_item.rb +2 -2
  386. data/lib/advanced_billing/models/list_subscription_components_filter.rb +2 -2
  387. data/lib/advanced_billing/models/list_subscription_components_for_site_filter.rb +2 -2
  388. data/lib/advanced_billing/models/list_subscription_components_include.rb +2 -2
  389. data/lib/advanced_billing/models/list_subscription_components_response.rb +2 -2
  390. data/lib/advanced_billing/models/list_subscription_components_sort.rb +2 -2
  391. data/lib/advanced_billing/models/list_subscription_group_prepayment.rb +2 -2
  392. data/lib/advanced_billing/models/list_subscription_group_prepayment_response.rb +2 -2
  393. data/lib/advanced_billing/models/list_subscription_groups_item.rb +2 -2
  394. data/lib/advanced_billing/models/list_subscription_groups_meta.rb +2 -2
  395. data/lib/advanced_billing/models/list_subscription_groups_response.rb +2 -2
  396. data/lib/advanced_billing/models/metadata.rb +2 -2
  397. data/lib/advanced_billing/models/metafield.rb +2 -2
  398. data/lib/advanced_billing/models/metafield_input.rb +2 -2
  399. data/lib/advanced_billing/models/metafield_scope.rb +2 -2
  400. data/lib/advanced_billing/models/metered_component.rb +2 -2
  401. data/lib/advanced_billing/models/metered_usage.rb +2 -2
  402. data/lib/advanced_billing/models/movement.rb +2 -2
  403. data/lib/advanced_billing/models/movement_line_item.rb +2 -2
  404. data/lib/advanced_billing/models/mrr.rb +2 -2
  405. data/lib/advanced_billing/models/mrr_movement.rb +2 -2
  406. data/lib/advanced_billing/models/mrr_response.rb +2 -2
  407. data/lib/advanced_billing/models/multi_invoice_payment.rb +2 -2
  408. data/lib/advanced_billing/models/multi_invoice_payment_response.rb +2 -2
  409. data/lib/advanced_billing/models/nested_subscription_group.rb +2 -2
  410. data/lib/advanced_billing/models/net_terms.rb +2 -2
  411. data/lib/advanced_billing/models/offer.rb +2 -2
  412. data/lib/advanced_billing/models/offer_discount.rb +2 -2
  413. data/lib/advanced_billing/models/offer_item.rb +2 -2
  414. data/lib/advanced_billing/models/offer_response.rb +2 -2
  415. data/lib/advanced_billing/models/offer_signup_page.rb +2 -2
  416. data/lib/advanced_billing/models/ok_response.rb +2 -2
  417. data/lib/advanced_billing/models/on_off_component.rb +2 -2
  418. data/lib/advanced_billing/models/organization_address.rb +2 -2
  419. data/lib/advanced_billing/models/origin_invoice.rb +2 -2
  420. data/lib/advanced_billing/models/overage_pricing.rb +2 -2
  421. data/lib/advanced_billing/models/override_subscription.rb +5 -3
  422. data/lib/advanced_billing/models/override_subscription_request.rb +2 -2
  423. data/lib/advanced_billing/models/paginated_metadata.rb +2 -2
  424. data/lib/advanced_billing/models/paid_invoice.rb +2 -2
  425. data/lib/advanced_billing/models/pause_request.rb +2 -2
  426. data/lib/advanced_billing/models/pay_pal_vault.rb +2 -2
  427. data/lib/advanced_billing/models/payer_attributes.rb +2 -2
  428. data/lib/advanced_billing/models/payer_error.rb +2 -2
  429. data/lib/advanced_billing/models/payment_collection_method_changed.rb +2 -2
  430. data/lib/advanced_billing/models/payment_for_allocation.rb +2 -2
  431. data/lib/advanced_billing/models/payment_method_apple_pay.rb +2 -2
  432. data/lib/advanced_billing/models/payment_method_bank_account.rb +2 -2
  433. data/lib/advanced_billing/models/payment_method_credit_card.rb +2 -2
  434. data/lib/advanced_billing/models/payment_method_external.rb +2 -2
  435. data/lib/advanced_billing/models/payment_method_paypal.rb +2 -2
  436. data/lib/advanced_billing/models/payment_profile_attributes.rb +2 -2
  437. data/lib/advanced_billing/models/payment_profile_response.rb +2 -2
  438. data/lib/advanced_billing/models/payment_related_events.rb +2 -2
  439. data/lib/advanced_billing/models/payment_type.rb +2 -2
  440. data/lib/advanced_billing/models/paypal_payment_profile.rb +43 -6
  441. data/lib/advanced_billing/models/pending_cancellation_change.rb +2 -2
  442. data/lib/advanced_billing/models/portal_management_link.rb +2 -2
  443. data/lib/advanced_billing/models/prepaid_configuration.rb +2 -2
  444. data/lib/advanced_billing/models/prepaid_configuration_response.rb +2 -2
  445. data/lib/advanced_billing/models/prepaid_product_price_point_filter.rb +2 -2
  446. data/lib/advanced_billing/models/prepaid_subscription_balance_changed.rb +2 -2
  447. data/lib/advanced_billing/models/prepaid_usage.rb +2 -2
  448. data/lib/advanced_billing/models/prepaid_usage_allocation_detail.rb +2 -2
  449. data/lib/advanced_billing/models/prepaid_usage_component.rb +2 -2
  450. data/lib/advanced_billing/models/prepayment.rb +2 -2
  451. data/lib/advanced_billing/models/prepayment_account_balance_changed.rb +2 -2
  452. data/lib/advanced_billing/models/prepayment_method.rb +2 -2
  453. data/lib/advanced_billing/models/prepayment_response.rb +2 -2
  454. data/lib/advanced_billing/models/prepayments_response.rb +2 -2
  455. data/lib/advanced_billing/models/preview_allocations_request.rb +2 -2
  456. data/lib/advanced_billing/models/price.rb +2 -2
  457. data/lib/advanced_billing/models/price_point_type.rb +2 -2
  458. data/lib/advanced_billing/models/pricing_scheme.rb +2 -2
  459. data/lib/advanced_billing/models/product.rb +2 -2
  460. data/lib/advanced_billing/models/product_family.rb +2 -2
  461. data/lib/advanced_billing/models/product_family_response.rb +2 -2
  462. data/lib/advanced_billing/models/product_price_point.rb +2 -2
  463. data/lib/advanced_billing/models/product_price_point_errors.rb +2 -2
  464. data/lib/advanced_billing/models/product_price_point_response.rb +2 -2
  465. data/lib/advanced_billing/models/product_response.rb +2 -2
  466. data/lib/advanced_billing/models/proforma_error.rb +2 -2
  467. data/lib/advanced_billing/models/proforma_invoice.rb +2 -2
  468. data/lib/advanced_billing/models/proforma_invoice_credit.rb +2 -2
  469. data/lib/advanced_billing/models/proforma_invoice_discount.rb +2 -2
  470. data/lib/advanced_billing/models/proforma_invoice_discount_source_type.rb +2 -2
  471. data/lib/advanced_billing/models/proforma_invoice_issued.rb +2 -2
  472. data/lib/advanced_billing/models/proforma_invoice_payment.rb +2 -2
  473. data/lib/advanced_billing/models/proforma_invoice_role.rb +2 -2
  474. data/lib/advanced_billing/models/proforma_invoice_status.rb +2 -2
  475. data/lib/advanced_billing/models/proforma_invoice_tax.rb +2 -2
  476. data/lib/advanced_billing/models/proforma_invoice_tax_source_type.rb +2 -2
  477. data/lib/advanced_billing/models/proration.rb +2 -2
  478. data/lib/advanced_billing/models/public_key.rb +2 -2
  479. data/lib/advanced_billing/models/public_signup_page.rb +2 -2
  480. data/lib/advanced_billing/models/quantity_based_component.rb +2 -2
  481. data/lib/advanced_billing/models/reactivate_subscription_group_request.rb +2 -2
  482. data/lib/advanced_billing/models/reactivate_subscription_group_response.rb +2 -2
  483. data/lib/advanced_billing/models/reactivate_subscription_request.rb +2 -2
  484. data/lib/advanced_billing/models/reactivation_billing.rb +2 -2
  485. data/lib/advanced_billing/models/reactivation_charge.rb +2 -2
  486. data/lib/advanced_billing/models/reason_code.rb +2 -2
  487. data/lib/advanced_billing/models/reason_code_response.rb +2 -2
  488. data/lib/advanced_billing/models/record_payment_request.rb +2 -2
  489. data/lib/advanced_billing/models/record_payment_response.rb +2 -2
  490. data/lib/advanced_billing/models/recurring_scheme.rb +2 -2
  491. data/lib/advanced_billing/models/referral_code.rb +2 -2
  492. data/lib/advanced_billing/models/referral_validation_response.rb +2 -2
  493. data/lib/advanced_billing/models/refund_consolidated_invoice.rb +2 -2
  494. data/lib/advanced_billing/models/refund_invoice.rb +2 -2
  495. data/lib/advanced_billing/models/refund_invoice_event.rb +2 -2
  496. data/lib/advanced_billing/models/refund_invoice_event_data.rb +2 -2
  497. data/lib/advanced_billing/models/refund_invoice_request.rb +2 -2
  498. data/lib/advanced_billing/models/refund_prepayment.rb +2 -2
  499. data/lib/advanced_billing/models/refund_prepayment_base_refund_error.rb +2 -2
  500. data/lib/advanced_billing/models/refund_prepayment_request.rb +2 -2
  501. data/lib/advanced_billing/models/refund_success.rb +2 -2
  502. data/lib/advanced_billing/models/remove_payment_event.rb +2 -2
  503. data/lib/advanced_billing/models/remove_payment_event_data.rb +2 -2
  504. data/lib/advanced_billing/models/renewal_preview.rb +2 -2
  505. data/lib/advanced_billing/models/renewal_preview_component.rb +2 -2
  506. data/lib/advanced_billing/models/renewal_preview_line_item.rb +2 -2
  507. data/lib/advanced_billing/models/renewal_preview_request.rb +2 -2
  508. data/lib/advanced_billing/models/renewal_preview_response.rb +2 -2
  509. data/lib/advanced_billing/models/replay_webhooks_request.rb +2 -2
  510. data/lib/advanced_billing/models/replay_webhooks_response.rb +2 -2
  511. data/lib/advanced_billing/models/resent_invitation.rb +2 -2
  512. data/lib/advanced_billing/models/resource_type.rb +2 -2
  513. data/lib/advanced_billing/models/restriction_type.rb +2 -2
  514. data/lib/advanced_billing/models/resume_options.rb +2 -2
  515. data/lib/advanced_billing/models/resumption_charge.rb +2 -2
  516. data/lib/advanced_billing/models/revoked_invitation.rb +2 -2
  517. data/lib/advanced_billing/models/sale_rep.rb +2 -2
  518. data/lib/advanced_billing/models/sale_rep_item_mrr.rb +2 -2
  519. data/lib/advanced_billing/models/sale_rep_settings.rb +2 -2
  520. data/lib/advanced_billing/models/sale_rep_subscription.rb +2 -2
  521. data/lib/advanced_billing/models/segment.rb +2 -2
  522. data/lib/advanced_billing/models/segment_price.rb +2 -2
  523. data/lib/advanced_billing/models/segment_response.rb +2 -2
  524. data/lib/advanced_billing/models/send_invoice_request.rb +2 -2
  525. data/lib/advanced_billing/models/service_credit.rb +2 -2
  526. data/lib/advanced_billing/models/service_credit1.rb +161 -0
  527. data/lib/advanced_billing/models/service_credit_response.rb +2 -2
  528. data/lib/advanced_billing/models/service_credit_type.rb +2 -2
  529. data/lib/advanced_billing/models/signup_proforma_preview.rb +2 -2
  530. data/lib/advanced_billing/models/signup_proforma_preview_response.rb +2 -2
  531. data/lib/advanced_billing/models/site.rb +2 -2
  532. data/lib/advanced_billing/models/site_response.rb +2 -2
  533. data/lib/advanced_billing/models/site_statistics.rb +2 -2
  534. data/lib/advanced_billing/models/site_summary.rb +2 -2
  535. data/lib/advanced_billing/models/snap_day.rb +2 -2
  536. data/lib/advanced_billing/models/sorting_direction.rb +2 -2
  537. data/lib/advanced_billing/models/subscription.rb +2 -2
  538. data/lib/advanced_billing/models/subscription_component.rb +2 -2
  539. data/lib/advanced_billing/models/subscription_component_allocation_error_item.rb +2 -2
  540. data/lib/advanced_billing/models/subscription_component_response.rb +2 -2
  541. data/lib/advanced_billing/models/subscription_component_subscription.rb +2 -2
  542. data/lib/advanced_billing/models/subscription_custom_price.rb +2 -2
  543. data/lib/advanced_billing/models/subscription_date_field.rb +2 -2
  544. data/lib/advanced_billing/models/subscription_filter.rb +2 -2
  545. data/lib/advanced_billing/models/subscription_group.rb +2 -2
  546. data/lib/advanced_billing/models/subscription_group_balances.rb +2 -2
  547. data/lib/advanced_billing/models/subscription_group_bank_account.rb +2 -2
  548. data/lib/advanced_billing/models/subscription_group_component_custom_price.rb +2 -2
  549. data/lib/advanced_billing/models/subscription_group_credit_card.rb +63 -61
  550. data/lib/advanced_billing/models/subscription_group_customer.rb +2 -2
  551. data/lib/advanced_billing/models/subscription_group_include.rb +2 -2
  552. data/lib/advanced_billing/models/subscription_group_item.rb +2 -2
  553. data/lib/advanced_billing/models/subscription_group_members_array_error.rb +2 -2
  554. data/lib/advanced_billing/models/subscription_group_payment_profile.rb +2 -2
  555. data/lib/advanced_billing/models/subscription_group_prepayment.rb +2 -2
  556. data/lib/advanced_billing/models/subscription_group_prepayment_method.rb +2 -2
  557. data/lib/advanced_billing/models/subscription_group_prepayment_request.rb +2 -2
  558. data/lib/advanced_billing/models/subscription_group_prepayment_response.rb +2 -2
  559. data/lib/advanced_billing/models/subscription_group_response.rb +2 -2
  560. data/lib/advanced_billing/models/subscription_group_signup.rb +2 -2
  561. data/lib/advanced_billing/models/subscription_group_signup_component.rb +2 -2
  562. data/lib/advanced_billing/models/subscription_group_signup_error.rb +2 -2
  563. data/lib/advanced_billing/models/subscription_group_signup_event_data.rb +2 -2
  564. data/lib/advanced_billing/models/subscription_group_signup_failure_data.rb +2 -2
  565. data/lib/advanced_billing/models/subscription_group_signup_item.rb +2 -2
  566. data/lib/advanced_billing/models/subscription_group_signup_request.rb +2 -2
  567. data/lib/advanced_billing/models/subscription_group_signup_response.rb +2 -2
  568. data/lib/advanced_billing/models/subscription_group_single_error.rb +2 -2
  569. data/lib/advanced_billing/models/subscription_group_subscription_error.rb +2 -2
  570. data/lib/advanced_billing/models/subscription_group_update_error.rb +2 -2
  571. data/lib/advanced_billing/models/subscription_groups_list_include.rb +2 -2
  572. data/lib/advanced_billing/models/subscription_include.rb +2 -2
  573. data/lib/advanced_billing/models/subscription_included_coupon.rb +2 -2
  574. data/lib/advanced_billing/models/subscription_list_date_field.rb +2 -2
  575. data/lib/advanced_billing/models/subscription_list_include.rb +2 -2
  576. data/lib/advanced_billing/models/subscription_migration_preview.rb +2 -2
  577. data/lib/advanced_billing/models/subscription_migration_preview_options.rb +2 -2
  578. data/lib/advanced_billing/models/subscription_migration_preview_request.rb +2 -2
  579. data/lib/advanced_billing/models/subscription_migration_preview_response.rb +2 -2
  580. data/lib/advanced_billing/models/subscription_mrr.rb +2 -2
  581. data/lib/advanced_billing/models/subscription_mrr_breakout.rb +2 -2
  582. data/lib/advanced_billing/models/subscription_mrr_response.rb +2 -2
  583. data/lib/advanced_billing/models/subscription_note.rb +2 -2
  584. data/lib/advanced_billing/models/subscription_note_response.rb +2 -2
  585. data/lib/advanced_billing/models/subscription_preview.rb +2 -2
  586. data/lib/advanced_billing/models/subscription_preview_response.rb +2 -2
  587. data/lib/advanced_billing/models/subscription_product_change.rb +2 -2
  588. data/lib/advanced_billing/models/subscription_product_migration.rb +2 -2
  589. data/lib/advanced_billing/models/subscription_product_migration_request.rb +2 -2
  590. data/lib/advanced_billing/models/subscription_purge_type.rb +2 -2
  591. data/lib/advanced_billing/models/subscription_response.rb +2 -2
  592. data/lib/advanced_billing/models/subscription_sort.rb +2 -2
  593. data/lib/advanced_billing/models/subscription_state.rb +2 -2
  594. data/lib/advanced_billing/models/subscription_state_change.rb +2 -2
  595. data/lib/advanced_billing/models/subscription_state_filter.rb +2 -2
  596. data/lib/advanced_billing/models/tax_configuration.rb +2 -2
  597. data/lib/advanced_billing/models/tax_configuration_kind.rb +2 -2
  598. data/lib/advanced_billing/models/tax_destination_address.rb +2 -2
  599. data/lib/advanced_billing/models/too_many_management_link_requests.rb +2 -2
  600. data/lib/advanced_billing/models/update_allocation_expiration_date.rb +2 -2
  601. data/lib/advanced_billing/models/update_component.rb +2 -2
  602. data/lib/advanced_billing/models/update_component_price_point.rb +2 -2
  603. data/lib/advanced_billing/models/update_component_price_point_request.rb +2 -2
  604. data/lib/advanced_billing/models/update_component_request.rb +2 -2
  605. data/lib/advanced_billing/models/update_coupon_currency.rb +2 -2
  606. data/lib/advanced_billing/models/update_currency_price.rb +2 -2
  607. data/lib/advanced_billing/models/update_currency_prices_request.rb +2 -2
  608. data/lib/advanced_billing/models/update_customer.rb +2 -2
  609. data/lib/advanced_billing/models/update_customer_request.rb +2 -2
  610. data/lib/advanced_billing/models/update_metadata.rb +2 -2
  611. data/lib/advanced_billing/models/update_metadata_request.rb +2 -2
  612. data/lib/advanced_billing/models/update_metafield.rb +2 -2
  613. data/lib/advanced_billing/models/update_metafields_request.rb +2 -2
  614. data/lib/advanced_billing/models/update_payment_profile.rb +2 -2
  615. data/lib/advanced_billing/models/update_payment_profile_request.rb +2 -2
  616. data/lib/advanced_billing/models/update_price.rb +2 -2
  617. data/lib/advanced_billing/models/update_product_price_point.rb +2 -2
  618. data/lib/advanced_billing/models/update_product_price_point_request.rb +2 -2
  619. data/lib/advanced_billing/models/update_reason_code.rb +2 -2
  620. data/lib/advanced_billing/models/update_reason_code_request.rb +2 -2
  621. data/lib/advanced_billing/models/update_segment.rb +2 -2
  622. data/lib/advanced_billing/models/update_segment_request.rb +2 -2
  623. data/lib/advanced_billing/models/update_subscription.rb +108 -27
  624. data/lib/advanced_billing/models/update_subscription_component.rb +2 -2
  625. data/lib/advanced_billing/models/update_subscription_group.rb +2 -2
  626. data/lib/advanced_billing/models/update_subscription_group_request.rb +2 -2
  627. data/lib/advanced_billing/models/update_subscription_note.rb +2 -2
  628. data/lib/advanced_billing/models/update_subscription_note_request.rb +2 -2
  629. data/lib/advanced_billing/models/update_subscription_request.rb +2 -2
  630. data/lib/advanced_billing/models/upsert_prepaid_configuration.rb +2 -2
  631. data/lib/advanced_billing/models/upsert_prepaid_configuration_request.rb +2 -2
  632. data/lib/advanced_billing/models/usage.rb +2 -2
  633. data/lib/advanced_billing/models/usage_response.rb +2 -2
  634. data/lib/advanced_billing/models/void_invoice.rb +2 -2
  635. data/lib/advanced_billing/models/void_invoice_event.rb +2 -2
  636. data/lib/advanced_billing/models/void_invoice_event_data.rb +2 -2
  637. data/lib/advanced_billing/models/void_invoice_request.rb +2 -2
  638. data/lib/advanced_billing/models/void_remainder_event.rb +2 -2
  639. data/lib/advanced_billing/models/void_remainder_event_data.rb +2 -2
  640. data/lib/advanced_billing/models/webhook.rb +2 -2
  641. data/lib/advanced_billing/models/webhook_order.rb +2 -2
  642. data/lib/advanced_billing/models/webhook_response.rb +2 -2
  643. data/lib/advanced_billing/models/webhook_status.rb +2 -2
  644. data/lib/advanced_billing/models/webhook_subscription.rb +2 -2
  645. data/lib/advanced_billing/utilities/date_time_helper.rb +2 -2
  646. data/lib/advanced_billing/utilities/file_wrapper.rb +2 -2
  647. data/lib/advanced_billing/utilities/union_type_lookup.rb +16 -2
  648. data/lib/advanced_billing.rb +6 -3
  649. metadata +11 -8
@@ -1,7 +1,7 @@
1
1
  # advanced_billing
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated for Maxio by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module AdvancedBilling
7
7
  # SubscriptionsController
@@ -137,10 +137,10 @@ module AdvancedBilling
137
137
  # # Passing Payment Information
138
138
  # ## Subscription with Chargify.js token
139
139
  # The `chargify_token` can be obtained using
140
- # [Chargify.js](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0
141
- # NjAzNDI0-overview). The token represents payment profile attributes that
142
- # were provided by the customer in their browser and stored at the payment
143
- # gateway.
140
+ # [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Char
141
+ # gify-js-Overview#chargify-js-overview-0-0). The token represents payment
142
+ # profile attributes that were provided by the customer in their browser and
143
+ # stored at the payment gateway.
144
144
  # The `payment_type` attribute may either be `credit_card` or
145
145
  # `bank_account`, depending on the type of payment method being added. If a
146
146
  # bank account is being passed, the payment attributes should be changed to
@@ -187,40 +187,6 @@ module AdvancedBilling
187
187
  # }
188
188
  # }
189
189
  # ```
190
- # ## Subscription with Credit Card
191
- # ```json
192
- # "subscription": {
193
- # "product_handle": "basic",
194
- # "customer_attributes": {
195
- # "first_name": "Joe",
196
- # "last_name": "Blow",
197
- # "email": "joe@example.com",
198
- # "zip": "02120",
199
- # "state": "MA",
200
- # "reference": "XYZ",
201
- # "phone": "(617) 111 - 0000",
202
- # "organization": "Acme",
203
- # "country": "US",
204
- # "city": "Boston",
205
- # "address_2": null,
206
- # "address": "123 Mass Ave."
207
- # },
208
- # "credit_card_attributes": {
209
- # "last_name": "Smith",
210
- # "first_name": "Joe",
211
- # "full_number": "4111111111111111",
212
- # "expiration_year": "2021",
213
- # "expiration_month": "1",
214
- # "card_type": "visa",
215
- # "billing_zip": "02120",
216
- # "billing_state": "MA",
217
- # "billing_country": "US",
218
- # "billing_city": "Boston",
219
- # "billing_address_2": null,
220
- # "billing_address": "123 Mass Ave."
221
- # }
222
- # }
223
- # ```
224
190
  # ## Subscription with ACH as Payment Profile
225
191
  # ```json
226
192
  # {
@@ -299,11 +265,11 @@ module AdvancedBilling
299
265
  # GoCardless](https://maxio.zendesk.com/hc/en-us/articles/24176159136909-GoC
300
266
  # ardless)
301
267
  # + [Using Chargify.js with GoCardless - minimal
302
- # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
303
- # DIy-examples#minimal-example-with-direct-debit-gocardless-gateway)
268
+ # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
269
+ # h_01K0PJ15QQZKCER8CFK40MR6XJ)
304
270
  # + [Using Chargify.js with GoCardless - full
305
- # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
306
- # DIy-examples#full-example-with-direct-debit-gocardless-gateway)
271
+ # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
272
+ # h_01K0PJ15QR09JVHWW0MCA7HVJV)
307
273
  # ```json
308
274
  # {
309
275
  # "subscription": {
@@ -361,12 +327,11 @@ module AdvancedBilling
361
327
  # Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-S
362
328
  # EPA-and-BECS-Direct-Debit)
363
329
  # + [Using Chargify.js with Stripe SEPA or BECS Direct Debit - minimal
364
- # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
365
- # DIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway
366
- # )
330
+ # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
331
+ # h_01K0PJ15QQFKKN8Z7B7DZ9AJS5)
367
332
  # + [Using Chargify.js with Stripe SEPA Direct Debit - full
368
- # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
369
- # DIy-examples#full-example-with-sepa-direct-debit-stripe-gateway)
333
+ # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
334
+ # h_01K0PJ15QR09JVHWW0MCA7HVJV)
370
335
  # ```json
371
336
  # {
372
337
  # "subscription": {
@@ -393,11 +358,11 @@ module AdvancedBilling
393
358
  # Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-S
394
359
  # EPA-and-BECS-Direct-Debit)
395
360
  # + [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal
396
- # example](page:development-tools/chargify-js/examples#minimal-example-with-
397
- # sepa-becs-or-bacs-direct-debit-stripe-gateway)
361
+ # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
362
+ # h_01K0PJ15QQFKKN8Z7B7DZ9AJS5)
398
363
  # + [Using Chargify.js with Stripe BECS Direct Debit - full
399
- # example](page:development-tools/chargify-js/examples#full-example-with-bec
400
- # s-direct-debit-stripe-gateway)
364
+ # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
365
+ # h_01K0PJ15QRX4B1TYZKZD8ZND6D)
401
366
  # ```json
402
367
  # {
403
368
  # "subscription": {
@@ -425,11 +390,11 @@ module AdvancedBilling
425
390
  # Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-S
426
391
  # EPA-and-BECS-Direct-Debit)
427
392
  # + [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal
428
- # example](page:development-tools/chargify-js/examples#minimal-example-with-
429
- # sepa-becs-or-bacs-direct-debit-stripe-gateway)
393
+ # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
394
+ # h_01K0PJ15QQFKKN8Z7B7DZ9AJS5)
430
395
  # + [Using Chargify.js with Stripe BACS Direct Debit - full
431
- # example](page:development-tools/chargify-js/examples#full-example-with-bac
432
- # s-direct-debit-stripe-gateway)
396
+ # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
397
+ # h_01K0PJ15QR7PA1DJ3XE9MD05FM)
433
398
  # ```json
434
399
  # {
435
400
  # "subscription": {
@@ -804,10 +769,11 @@ module AdvancedBilling
804
769
  # }
805
770
  # }
806
771
  # ```
807
- # @param [CreateSubscriptionRequest] body Optional parameter: Example:
808
- # @return [SubscriptionResponse] response from the API call.
772
+ # @param [CreateSubscriptionRequest] body Optional parameter: TODO: type
773
+ # description here
774
+ # @return [SubscriptionResponse] Response from the API call.
809
775
  def create_subscription(body: nil)
810
- new_api_call_builder
776
+ @api_call
811
777
  .request(new_request_builder(HttpMethodEnum::POST,
812
778
  '/subscriptions.json',
813
779
  Server::PRODUCTION)
@@ -856,6 +822,8 @@ module AdvancedBilling
856
822
  # @param [Integer] coupon Optional parameter: The numeric id of the coupon
857
823
  # currently applied to the subscription. (This can be found in the URL when
858
824
  # editing a coupon. Note that the coupon code cannot be used.)
825
+ # @param [String] coupon_code Optional parameter: The coupon code currently
826
+ # applied to the subscription
859
827
  # @param [SubscriptionDateField] date_field Optional parameter: The type of
860
828
  # filter you'd like to apply to your search. Allowed Values: ,
861
829
  # current_period_ends_at, current_period_starts_at, created_at,
@@ -891,9 +859,9 @@ module AdvancedBilling
891
859
  # @param [Array[SubscriptionListInclude]] include Optional parameter: Allows
892
860
  # including additional data in the response. Use in query:
893
861
  # `include[]=self_service_page_token`.
894
- # @return [Array[SubscriptionResponse]] response from the API call.
862
+ # @return [Array[SubscriptionResponse]] Response from the API call.
895
863
  def list_subscriptions(options = {})
896
- new_api_call_builder
864
+ @api_call
897
865
  .request(new_request_builder(HttpMethodEnum::GET,
898
866
  '/subscriptions.json',
899
867
  Server::PRODUCTION)
@@ -903,6 +871,7 @@ module AdvancedBilling
903
871
  .query_param(new_parameter(options['product'], key: 'product'))
904
872
  .query_param(new_parameter(options['product_price_point_id'], key: 'product_price_point_id'))
905
873
  .query_param(new_parameter(options['coupon'], key: 'coupon'))
874
+ .query_param(new_parameter(options['coupon_code'], key: 'coupon_code'))
906
875
  .query_param(new_parameter(options['date_field'], key: 'date_field'))
907
876
  .query_param(new_parameter(options['start_date'], key: 'start_date'))
908
877
  .query_param(new_parameter(options['end_date'], key: 'end_date'))
@@ -986,11 +955,12 @@ module AdvancedBilling
986
955
  # `null`.
987
956
  # @param [Integer] subscription_id Required parameter: The Chargify id of
988
957
  # the subscription
989
- # @param [UpdateSubscriptionRequest] body Optional parameter: Example:
990
- # @return [SubscriptionResponse] response from the API call.
958
+ # @param [UpdateSubscriptionRequest] body Optional parameter: TODO: type
959
+ # description here
960
+ # @return [SubscriptionResponse] Response from the API call.
991
961
  def update_subscription(subscription_id,
992
962
  body: nil)
993
- new_api_call_builder
963
+ @api_call
994
964
  .request(new_request_builder(HttpMethodEnum::PUT,
995
965
  '/subscriptions/{subscription_id}.json',
996
966
  Server::PRODUCTION)
@@ -1022,10 +992,10 @@ module AdvancedBilling
1022
992
  # @param [Array[SubscriptionInclude]] include Optional parameter: Allows
1023
993
  # including additional data in the response. Use in query:
1024
994
  # `include[]=coupons&include[]=self_service_page_token`.
1025
- # @return [SubscriptionResponse] response from the API call.
995
+ # @return [SubscriptionResponse] Response from the API call.
1026
996
  def read_subscription(subscription_id,
1027
997
  include: nil)
1028
- new_api_call_builder
998
+ @api_call
1029
999
  .request(new_request_builder(HttpMethodEnum::GET,
1030
1000
  '/subscriptions/{subscription_id}.json',
1031
1001
  Server::PRODUCTION)
@@ -1078,10 +1048,10 @@ module AdvancedBilling
1078
1048
  # the subscription
1079
1049
  # @param [OverrideSubscriptionRequest] body Optional parameter: Only these
1080
1050
  # fields are available to be set.
1081
- # @return [void] response from the API call.
1051
+ # @return [void] Response from the API call.
1082
1052
  def override_subscription(subscription_id,
1083
1053
  body: nil)
1084
- new_api_call_builder
1054
+ @api_call
1085
1055
  .request(new_request_builder(HttpMethodEnum::PUT,
1086
1056
  '/subscriptions/{subscription_id}/override.json',
1087
1057
  Server::PRODUCTION)
@@ -1103,9 +1073,9 @@ module AdvancedBilling
1103
1073
 
1104
1074
  # Use this endpoint to find a subscription by its reference.
1105
1075
  # @param [String] reference Optional parameter: Subscription reference
1106
- # @return [SubscriptionResponse] response from the API call.
1076
+ # @return [SubscriptionResponse] Response from the API call.
1107
1077
  def find_subscription(reference: nil)
1108
- new_api_call_builder
1078
+ @api_call
1109
1079
  .request(new_request_builder(HttpMethodEnum::GET,
1110
1080
  '/subscriptions/lookup.json',
1111
1081
  Server::PRODUCTION)
@@ -1138,11 +1108,11 @@ module AdvancedBilling
1138
1108
  # @param [Array[SubscriptionPurgeType]] cascade Optional parameter: Options
1139
1109
  # are "customer" or "payment_profile". Use in query:
1140
1110
  # `cascade[]=customer&cascade[]=payment_profile`.
1141
- # @return [SubscriptionResponse] response from the API call.
1111
+ # @return [SubscriptionResponse] Response from the API call.
1142
1112
  def purge_subscription(subscription_id,
1143
1113
  ack,
1144
1114
  cascade: nil)
1145
- new_api_call_builder
1115
+ @api_call
1146
1116
  .request(new_request_builder(HttpMethodEnum::POST,
1147
1117
  '/subscriptions/{subscription_id}/purge.json',
1148
1118
  Server::PRODUCTION)
@@ -1168,12 +1138,12 @@ module AdvancedBilling
1168
1138
  # Use this endpoint to update a subscription's prepaid configuration.
1169
1139
  # @param [Integer] subscription_id Required parameter: The Chargify id of
1170
1140
  # the subscription
1171
- # @param [UpsertPrepaidConfigurationRequest] body Optional parameter:
1172
- # Example:
1173
- # @return [PrepaidConfigurationResponse] response from the API call.
1141
+ # @param [UpsertPrepaidConfigurationRequest] body Optional parameter: TODO:
1142
+ # type description here
1143
+ # @return [PrepaidConfigurationResponse] Response from the API call.
1174
1144
  def update_prepaid_subscription_configuration(subscription_id,
1175
1145
  body: nil)
1176
- new_api_call_builder
1146
+ @api_call
1177
1147
  .request(new_request_builder(HttpMethodEnum::POST,
1178
1148
  '/subscriptions/{subscription_id}/prepaid_configurations.json',
1179
1149
  Server::PRODUCTION)
@@ -1198,12 +1168,12 @@ module AdvancedBilling
1198
1168
  # The Chargify API allows you to preview a subscription by POSTing the same
1199
1169
  # JSON or XML as for a subscription creation.
1200
1170
  # The "Next Billing" amount and "Next Billing" date are represented in each
1201
- # Subscriber's Summary. For more information, please see our documentation
1171
+ # Subscriber's Summary.
1172
+ # A subscription will not be created by utilizing this endpoint; it is meant
1173
+ # to serve as a prediction.
1174
+ # For more information, please see our documentation
1202
1175
  # [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscrib
1203
1176
  # er-Interface-Overview).
1204
- # ## Side effects
1205
- # A subscription will not be created by sending a POST to this endpoint. It
1206
- # is meant to serve as a prediction.
1207
1177
  # ## Taxable Subscriptions
1208
1178
  # This endpoint will preview taxes applicable to a purchase. In order for
1209
1179
  # taxes to be previewed, the following conditions must be met:
@@ -1230,10 +1200,11 @@ module AdvancedBilling
1230
1200
  # ## Non-taxable Subscriptions
1231
1201
  # If you'd like to calculate subscriptions that do not include tax, please
1232
1202
  # feel free to leave off the billing information.
1233
- # @param [CreateSubscriptionRequest] body Optional parameter: Example:
1234
- # @return [SubscriptionPreviewResponse] response from the API call.
1203
+ # @param [CreateSubscriptionRequest] body Optional parameter: TODO: type
1204
+ # description here
1205
+ # @return [SubscriptionPreviewResponse] Response from the API call.
1235
1206
  def preview_subscription(body: nil)
1236
- new_api_call_builder
1207
+ @api_call
1237
1208
  .request(new_request_builder(HttpMethodEnum::POST,
1238
1209
  '/subscriptions/preview.json',
1239
1210
  Server::PRODUCTION)
@@ -1265,12 +1236,13 @@ module AdvancedBilling
1265
1236
  # the subscription
1266
1237
  # @param [String] code Optional parameter: A code for the coupon that would
1267
1238
  # be applied to a subscription
1268
- # @param [AddCouponsRequest] body Optional parameter: Example:
1269
- # @return [SubscriptionResponse] response from the API call.
1239
+ # @param [AddCouponsRequest] body Optional parameter: TODO: type description
1240
+ # here
1241
+ # @return [SubscriptionResponse] Response from the API call.
1270
1242
  def apply_coupons_to_subscription(subscription_id,
1271
1243
  code: nil,
1272
1244
  body: nil)
1273
- new_api_call_builder
1245
+ @api_call
1274
1246
  .request(new_request_builder(HttpMethodEnum::POST,
1275
1247
  '/subscriptions/{subscription_id}/add_coupon.json',
1276
1248
  Server::PRODUCTION)
@@ -1301,10 +1273,10 @@ module AdvancedBilling
1301
1273
  # @param [Integer] subscription_id Required parameter: The Chargify id of
1302
1274
  # the subscription
1303
1275
  # @param [String] coupon_code Optional parameter: The coupon code
1304
- # @return [String] response from the API call.
1276
+ # @return [String] Response from the API call.
1305
1277
  def remove_coupon_from_subscription(subscription_id,
1306
1278
  coupon_code: nil)
1307
- new_api_call_builder
1279
+ @api_call
1308
1280
  .request(new_request_builder(HttpMethodEnum::DELETE,
1309
1281
  '/subscriptions/{subscription_id}/remove_coupon.json',
1310
1282
  Server::PRODUCTION)
@@ -1315,7 +1287,7 @@ module AdvancedBilling
1315
1287
  .auth(Single.new('BasicAuth')))
1316
1288
  .response(new_response_handler
1317
1289
  .deserializer(APIHelper.method(:deserialize_primitive_types))
1318
- .deserialize_into(proc do |response| response.to_s end)
1290
+ .deserialize_into(proc do |response| response&.to_s end)
1319
1291
  .is_primitive_response(true)
1320
1292
  .local_error_template('422',
1321
1293
  'HTTP Response Not OK. Status code: {$statusCode}.'\
@@ -1377,11 +1349,12 @@ module AdvancedBilling
1377
1349
  # invoice back to the subscription.
1378
1350
  # @param [Integer] subscription_id Required parameter: The Chargify id of
1379
1351
  # the subscription
1380
- # @param [ActivateSubscriptionRequest] body Optional parameter: Example:
1381
- # @return [SubscriptionResponse] response from the API call.
1352
+ # @param [ActivateSubscriptionRequest] body Optional parameter: TODO: type
1353
+ # description here
1354
+ # @return [SubscriptionResponse] Response from the API call.
1382
1355
  def activate_subscription(subscription_id,
1383
1356
  body: nil)
1384
- new_api_call_builder
1357
+ @api_call
1385
1358
  .request(new_request_builder(HttpMethodEnum::PUT,
1386
1359
  '/subscriptions/{subscription_id}/activate.json',
1387
1360
  Server::PRODUCTION)
@@ -1,35 +1,15 @@
1
1
  # advanced_billing
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated for Maxio by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module AdvancedBilling
7
7
  # WebhooksController
8
8
  class WebhooksController < BaseController
9
- # ## Webhooks Intro
10
- # The Webhooks API allows you to view a list of all webhooks and to
11
- # selectively resend individual or groups of webhooks. Webhooks will be sent
12
- # on endpoints specified by you. Endpoints can be added via API or Web UI.
13
- # There is also an option to enable / disable webhooks via API request.
14
- # We recommend that you review Advanced Billing's webhook documentation
15
- # located in our help site. The following resources will help guide you on
16
- # how to use webhooks in Advanced Billing, in addition to these webhook
17
- # endpoints:
18
- # + [Adding/editing new
19
- # webhooks](https://maxio.zendesk.com/hc/en-us/articles/24286723085197-Webho
20
- # oks#configure-webhook-url)
21
- # + [Webhooks introduction and delivery
22
- # information](https://maxio.zendesk.com/hc/en-us/articles/24266143173901-We
23
- # bhooks-Overview)
24
- # + [Main webhook
25
- # reference](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webh
26
- # ooks-Reference)
27
- # + [Available webhooks and
28
- # payloads](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webho
29
- # oks-Reference#events)
30
- # ## List Webhooks for a Site
31
- # This method allows you to fetch data about webhooks. You can pass query
32
- # parameters if you want to filter webhooks.
9
+ # Allows you to view a list of webhooks. You can pass query parameters if
10
+ # you want to filter webhooks. See the
11
+ # [Webhooks](page:introduction/webhooks/webhooks) documentation for more
12
+ # information.
33
13
  # @param [WebhookStatus] status Optional parameter: Webhooks with matching
34
14
  # status would be returned.
35
15
  # @param [String] since_date Optional parameter: Format YYYY-MM-DD. Returns
@@ -53,9 +33,9 @@ module AdvancedBilling
53
33
  # Webhooks are returned.
54
34
  # @param [Integer] subscription Optional parameter: The Advanced Billing id
55
35
  # of a subscription you'd like to filter for
56
- # @return [Array[WebhookResponse]] response from the API call.
36
+ # @return [Array[WebhookResponse]] Response from the API call.
57
37
  def list_webhooks(options = {})
58
- new_api_call_builder
38
+ @api_call
59
39
  .request(new_request_builder(HttpMethodEnum::GET,
60
40
  '/webhooks.json',
61
41
  Server::PRODUCTION)
@@ -75,11 +55,12 @@ module AdvancedBilling
75
55
  .execute
76
56
  end
77
57
 
78
- # This method allows you to enable webhooks via API for your site
79
- # @param [EnableWebhooksRequest] body Optional parameter: Example:
80
- # @return [EnableWebhooksResponse] response from the API call.
58
+ # Allows you to enable webhooks for your site
59
+ # @param [EnableWebhooksRequest] body Optional parameter: TODO: type
60
+ # description here
61
+ # @return [EnableWebhooksResponse] Response from the API call.
81
62
  def enable_webhooks(body: nil)
82
- new_api_call_builder
63
+ @api_call
83
64
  .request(new_request_builder(HttpMethodEnum::PUT,
84
65
  '/webhooks/settings.json',
85
66
  Server::PRODUCTION)
@@ -94,15 +75,15 @@ module AdvancedBilling
94
75
  .execute
95
76
  end
96
77
 
97
- # Posting to the replay endpoint does not immediately resend the webhooks.
98
- # They are added to a queue and will be sent as soon as possible, depending
99
- # on available system resources.
100
- # You may submit an array of up to 1000 webhook IDs to replay in the
101
- # request.
102
- # @param [ReplayWebhooksRequest] body Optional parameter: Example:
103
- # @return [ReplayWebhooksResponse] response from the API call.
78
+ # Replays webhooks. Posting to this endpoint does not immediately resend the
79
+ # webhooks. They are added to a queue and sent as soon as possible,
80
+ # depending on available system resources. You can submit an array of up to
81
+ # 1000 webhook IDs in the replay request.
82
+ # @param [ReplayWebhooksRequest] body Optional parameter: TODO: type
83
+ # description here
84
+ # @return [ReplayWebhooksResponse] Response from the API call.
104
85
  def replay_webhooks(body: nil)
105
- new_api_call_builder
86
+ @api_call
106
87
  .request(new_request_builder(HttpMethodEnum::POST,
107
88
  '/webhooks/replay.json',
108
89
  Server::PRODUCTION)
@@ -117,16 +98,16 @@ module AdvancedBilling
117
98
  .execute
118
99
  end
119
100
 
120
- # The Chargify API allows you to create an endpoint and assign a list of
121
- # webhooks subscriptions (events) to it.
122
- # You can check available events here.
123
- # [Event
124
- # keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-
125
- # Reference#events)
126
- # @param [CreateOrUpdateEndpointRequest] body Optional parameter: Example:
127
- # @return [EndpointResponse] response from the API call.
101
+ # Creates an endpoint and assigns a list of webhooks subscriptions (events)
102
+ # to it.
103
+ # See the [Webhooks
104
+ # Reference](page:introduction/webhooks/webhooks-reference#events) page for
105
+ # available events.
106
+ # @param [CreateOrUpdateEndpointRequest] body Optional parameter: TODO: type
107
+ # description here
108
+ # @return [EndpointResponse] Response from the API call.
128
109
  def create_endpoint(body: nil)
129
- new_api_call_builder
110
+ @api_call
130
111
  .request(new_request_builder(HttpMethodEnum::POST,
131
112
  '/endpoints.json',
132
113
  Server::PRODUCTION)
@@ -145,10 +126,10 @@ module AdvancedBilling
145
126
  .execute
146
127
  end
147
128
 
148
- # This method returns created endpoints for site.
149
- # @return [Array[Endpoint]] response from the API call.
129
+ # Returns created endpoints for a site.
130
+ # @return [Array[Endpoint]] Response from the API call.
150
131
  def list_endpoints
151
- new_api_call_builder
132
+ @api_call
152
133
  .request(new_request_builder(HttpMethodEnum::GET,
153
134
  '/endpoints.json',
154
135
  Server::PRODUCTION)
@@ -161,25 +142,23 @@ module AdvancedBilling
161
142
  .execute
162
143
  end
163
144
 
164
- # You can update an Endpoint via the API with a PUT request to the resource
165
- # endpoint.
166
- # You can change the `url` of your endpoint which consumes webhooks or list
167
- # of `webhook_subscriptions`.
168
- # Check available [Event
169
- # keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-
170
- # Reference#events).
171
- # Always send a complete list of events which you want subscribe/watch.
172
- # Sending an PUT request for existing endpoint with empty list of
173
- # `webhook_subscriptions` will end with unsubscribe from all events.
174
- # If you want unsubscribe from specific event, just send a list of
145
+ # Updates an Endpoint. You can change the `url` of your endpoint or the list
146
+ # of `webhook_subscriptions` to which you are subscribed. See the [Webhooks
147
+ # Reference](page:introduction/webhooks/webhooks-reference#events) page for
148
+ # available events.
149
+ # Always send a complete list of events to which you want to subscribe.
150
+ # Sending a PUT request for an existing endpoint with an empty list of
151
+ # `webhook_subscriptions` will unsubscribe all events.
152
+ # If you want unsubscribe from a specific event, send a list of
175
153
  # `webhook_subscriptions` without the specific event key.
176
154
  # @param [Integer] endpoint_id Required parameter: The Advanced Billing id
177
155
  # for the endpoint that should be updated
178
- # @param [CreateOrUpdateEndpointRequest] body Optional parameter: Example:
179
- # @return [EndpointResponse] response from the API call.
156
+ # @param [CreateOrUpdateEndpointRequest] body Optional parameter: TODO: type
157
+ # description here
158
+ # @return [EndpointResponse] Response from the API call.
180
159
  def update_endpoint(endpoint_id,
181
160
  body: nil)
182
- new_api_call_builder
161
+ @api_call
183
162
  .request(new_request_builder(HttpMethodEnum::PUT,
184
163
  '/endpoints/{endpoint_id}.json',
185
164
  Server::PRODUCTION)
@@ -1,7 +1,7 @@
1
1
  # advanced_billing
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated for Maxio by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module AdvancedBilling
7
7
  # Class for exceptions when there is a network error, status code error, etc.
@@ -1,7 +1,7 @@
1
1
  # advanced_billing
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated for Maxio by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module AdvancedBilling
7
7
  # Component Allocation Error class.
@@ -14,8 +14,8 @@ module AdvancedBilling
14
14
  attr_accessor :errors
15
15
 
16
16
  # The constructor.
17
- # @param [String] The reason for raising an exception.
18
- # @param [HttpResponse] The HttpReponse of the API call.
17
+ # @param [String] reason The reason for raising an exception.
18
+ # @param [HttpResponse] response The HttpReponse of the API call.
19
19
  def initialize(reason, response)
20
20
  super(reason, response)
21
21
  hash = APIHelper.json_deserialize(@response.raw_body)
@@ -23,9 +23,11 @@ module AdvancedBilling
23
23
  end
24
24
 
25
25
  # Populates this object by extracting properties from a hash.
26
- # @param [Hash] The deserialized response sent by the server in the
26
+ # @param [Hash] hash The deserialized response sent by the server in the
27
27
  # response body.
28
28
  def unbox(hash)
29
+ return nil unless hash
30
+
29
31
  # Parameter is an array, so we need to iterate through it
30
32
  @errors = nil
31
33
  unless hash['errors'].nil?
@@ -1,7 +1,7 @@
1
1
  # advanced_billing
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated for Maxio by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module AdvancedBilling
7
7
  # Component PricePoint Error class.
@@ -14,8 +14,8 @@ module AdvancedBilling
14
14
  attr_accessor :errors
15
15
 
16
16
  # The constructor.
17
- # @param [String] The reason for raising an exception.
18
- # @param [HttpResponse] The HttpReponse of the API call.
17
+ # @param [String] reason The reason for raising an exception.
18
+ # @param [HttpResponse] response The HttpReponse of the API call.
19
19
  def initialize(reason, response)
20
20
  super(reason, response)
21
21
  hash = APIHelper.json_deserialize(@response.raw_body)
@@ -23,9 +23,11 @@ module AdvancedBilling
23
23
  end
24
24
 
25
25
  # Populates this object by extracting properties from a hash.
26
- # @param [Hash] The deserialized response sent by the server in the
26
+ # @param [Hash] hash The deserialized response sent by the server in the
27
27
  # response body.
28
28
  def unbox(hash)
29
+ return nil unless hash
30
+
29
31
  # Parameter is an array, so we need to iterate through it
30
32
  @errors = nil
31
33
  unless hash['errors'].nil?
@@ -1,7 +1,7 @@
1
1
  # advanced_billing
2
2
  #
3
- # This file was automatically generated by APIMATIC v2.0
4
- # ( https://apimatic.io ).
3
+ # This file was automatically generated for Maxio by
4
+ # APIMATIC v3.0 ( https://www.apimatic.io ).
5
5
 
6
6
  module AdvancedBilling
7
7
  # Customer Error Response class.
@@ -14,8 +14,8 @@ module AdvancedBilling
14
14
  attr_accessor :errors
15
15
 
16
16
  # The constructor.
17
- # @param [String] The reason for raising an exception.
18
- # @param [HttpResponse] The HttpReponse of the API call.
17
+ # @param [String] reason The reason for raising an exception.
18
+ # @param [HttpResponse] response The HttpReponse of the API call.
19
19
  def initialize(reason, response)
20
20
  super(reason, response)
21
21
  hash = APIHelper.json_deserialize(@response.raw_body)
@@ -23,9 +23,11 @@ module AdvancedBilling
23
23
  end
24
24
 
25
25
  # Populates this object by extracting properties from a hash.
26
- # @param [Hash] The deserialized response sent by the server in the
26
+ # @param [Hash] hash The deserialized response sent by the server in the
27
27
  # response body.
28
28
  def unbox(hash)
29
+ return nil unless hash
30
+
29
31
  @errors = hash.key?('errors') ? APIHelper.deserialize_union_type(
30
32
  UnionTypeLookUp.get(:CustomerErrorResponseErrors), hash['errors']
31
33
  ) : SKIP