orb-apiamtic-sdk 0.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 (659) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +28 -0
  3. data/README.md +177 -0
  4. data/bin/console +15 -0
  5. data/lib/api_reference/api_helper.rb +10 -0
  6. data/lib/api_reference/apis/alert_api.rb +497 -0
  7. data/lib/api_reference/apis/availability_api.rb +51 -0
  8. data/lib/api_reference/apis/base_api.rb +65 -0
  9. data/lib/api_reference/apis/coupon_api.rb +250 -0
  10. data/lib/api_reference/apis/credit_api.rb +1269 -0
  11. data/lib/api_reference/apis/credit_note_api.rb +181 -0
  12. data/lib/api_reference/apis/customer_api.rb +1058 -0
  13. data/lib/api_reference/apis/dimensional_price_group_api.rb +289 -0
  14. data/lib/api_reference/apis/event_api.rb +776 -0
  15. data/lib/api_reference/apis/invoice_api.rb +933 -0
  16. data/lib/api_reference/apis/item_api.rb +224 -0
  17. data/lib/api_reference/apis/license_api.rb +452 -0
  18. data/lib/api_reference/apis/license_type_api.rb +147 -0
  19. data/lib/api_reference/apis/metric_api.rb +211 -0
  20. data/lib/api_reference/apis/plan_api.rb +763 -0
  21. data/lib/api_reference/apis/price_api.rb +538 -0
  22. data/lib/api_reference/apis/price_interval_api.rb +134 -0
  23. data/lib/api_reference/apis/subscription_api.rb +1575 -0
  24. data/lib/api_reference/apis/subscription_change_api.rb +213 -0
  25. data/lib/api_reference/client.rb +175 -0
  26. data/lib/api_reference/configuration.rb +166 -0
  27. data/lib/api_reference/exceptions/api_exception.rb +21 -0
  28. data/lib/api_reference/exceptions/authorization_error_exception.rb +60 -0
  29. data/lib/api_reference/exceptions/idempotency_request_mismatch_exception.rb +60 -0
  30. data/lib/api_reference/exceptions/server_error_exception.rb +61 -0
  31. data/lib/api_reference/exceptions/too_many_requests_exception.rb +60 -0
  32. data/lib/api_reference/http/api_response.rb +19 -0
  33. data/lib/api_reference/http/auth/oauth_2.rb +53 -0
  34. data/lib/api_reference/http/http_call_back.rb +10 -0
  35. data/lib/api_reference/http/http_method_enum.rb +10 -0
  36. data/lib/api_reference/http/http_request.rb +10 -0
  37. data/lib/api_reference/http/http_response.rb +10 -0
  38. data/lib/api_reference/http/proxy_settings.rb +22 -0
  39. data/lib/api_reference/logging/configuration/api_logging_configuration.rb +186 -0
  40. data/lib/api_reference/logging/sdk_logger.rb +17 -0
  41. data/lib/api_reference/models/accounting_provider.rb +108 -0
  42. data/lib/api_reference/models/accounting_provider_config.rb +84 -0
  43. data/lib/api_reference/models/accounting_sync_configuration.rb +117 -0
  44. data/lib/api_reference/models/action.rb +68 -0
  45. data/lib/api_reference/models/add_adjustment_interval_params.rb +148 -0
  46. data/lib/api_reference/models/add_amendment_credit_ledger_entry_request_params.rb +144 -0
  47. data/lib/api_reference/models/add_credit_top_up_request_params.rb +149 -0
  48. data/lib/api_reference/models/add_decrement_credit_ledger_entry_request_params.rb +145 -0
  49. data/lib/api_reference/models/add_edit_price_interval_params.rb +161 -0
  50. data/lib/api_reference/models/add_expiration_change_credit_ledger_entry_request_params.rb +193 -0
  51. data/lib/api_reference/models/add_increment_credit_ledger_entry_request_params.rb +237 -0
  52. data/lib/api_reference/models/add_plan_adjustment_params.rb +90 -0
  53. data/lib/api_reference/models/add_plan_price_params.rb +103 -0
  54. data/lib/api_reference/models/add_price_interval_params.rb +297 -0
  55. data/lib/api_reference/models/add_subscription_adjustment_params.rb +146 -0
  56. data/lib/api_reference/models/add_subscription_price_params.rb +234 -0
  57. data/lib/api_reference/models/add_void_credit_ledger_entry_request_params.rb +169 -0
  58. data/lib/api_reference/models/address.rb +162 -0
  59. data/lib/api_reference/models/address_input.rb +131 -0
  60. data/lib/api_reference/models/adjustment_interval.rb +163 -0
  61. data/lib/api_reference/models/affected_block.rb +155 -0
  62. data/lib/api_reference/models/aggregated_cost.rb +131 -0
  63. data/lib/api_reference/models/alert.rb +339 -0
  64. data/lib/api_reference/models/alerts.rb +92 -0
  65. data/lib/api_reference/models/allocation.rb +157 -0
  66. data/lib/api_reference/models/amend_event_result.rb +73 -0
  67. data/lib/api_reference/models/amended_event.rb +115 -0
  68. data/lib/api_reference/models/amendment_ledger_entry.rb +301 -0
  69. data/lib/api_reference/models/amount_discount.rb +150 -0
  70. data/lib/api_reference/models/amount_discount_creation_params.rb +81 -0
  71. data/lib/api_reference/models/amount_discount_interval.rb +187 -0
  72. data/lib/api_reference/models/api_pagination_params.rb +74 -0
  73. data/lib/api_reference/models/apply_params.rb +136 -0
  74. data/lib/api_reference/models/auto_collection.rb +157 -0
  75. data/lib/api_reference/models/backfill.rb +214 -0
  76. data/lib/api_reference/models/backfill_status.rb +44 -0
  77. data/lib/api_reference/models/backfills.rb +92 -0
  78. data/lib/api_reference/models/balance_alert_status.rb +105 -0
  79. data/lib/api_reference/models/base_model.rb +110 -0
  80. data/lib/api_reference/models/billable_metric.rb +155 -0
  81. data/lib/api_reference/models/billable_metric_minified.rb +86 -0
  82. data/lib/api_reference/models/billable_metric_simple.rb +104 -0
  83. data/lib/api_reference/models/billable_metric_tiny.rb +86 -0
  84. data/lib/api_reference/models/billable_metrics.rb +92 -0
  85. data/lib/api_reference/models/billing_cycle_alignment.rb +40 -0
  86. data/lib/api_reference/models/billing_cycle_anchor_configuration.rb +117 -0
  87. data/lib/api_reference/models/billing_cycle_configuration.rb +104 -0
  88. data/lib/api_reference/models/billing_mode.rb +36 -0
  89. data/lib/api_reference/models/block_price_filter.rb +114 -0
  90. data/lib/api_reference/models/bulk_config.rb +87 -0
  91. data/lib/api_reference/models/bulk_price.rb +584 -0
  92. data/lib/api_reference/models/bulk_tier.rb +87 -0
  93. data/lib/api_reference/models/bulk_tier_with_proration.rb +88 -0
  94. data/lib/api_reference/models/bulk_with_filters_config.rb +98 -0
  95. data/lib/api_reference/models/bulk_with_filters_config1.rb +116 -0
  96. data/lib/api_reference/models/bulk_with_filters_price.rb +587 -0
  97. data/lib/api_reference/models/bulk_with_filters_tier.rb +88 -0
  98. data/lib/api_reference/models/bulk_with_proration_config.rb +69 -0
  99. data/lib/api_reference/models/bulk_with_proration_config1.rb +87 -0
  100. data/lib/api_reference/models/bulk_with_proration_price.rb +587 -0
  101. data/lib/api_reference/models/cadence.rb +52 -0
  102. data/lib/api_reference/models/cadence104.rb +52 -0
  103. data/lib/api_reference/models/cadence34.rb +48 -0
  104. data/lib/api_reference/models/cancel_option.rb +40 -0
  105. data/lib/api_reference/models/cancel_subscription_params.rb +102 -0
  106. data/lib/api_reference/models/change_option.rb +42 -0
  107. data/lib/api_reference/models/change_option1.rb +40 -0
  108. data/lib/api_reference/models/changed_subscription_resources.rb +185 -0
  109. data/lib/api_reference/models/constraint_violation_error.rb +101 -0
  110. data/lib/api_reference/models/conversion_rate_tier.rb +82 -0
  111. data/lib/api_reference/models/conversion_rate_tiered_config.rb +69 -0
  112. data/lib/api_reference/models/conversion_rate_unit_config.rb +60 -0
  113. data/lib/api_reference/models/costs_request_params.rb +118 -0
  114. data/lib/api_reference/models/country.rb +492 -0
  115. data/lib/api_reference/models/coupon.rb +195 -0
  116. data/lib/api_reference/models/coupon_query_params.rb +99 -0
  117. data/lib/api_reference/models/coupon_redemption.rb +132 -0
  118. data/lib/api_reference/models/coupons.rb +92 -0
  119. data/lib/api_reference/models/create_credit_note_params.rb +120 -0
  120. data/lib/api_reference/models/create_customer_alert_request_params.rb +91 -0
  121. data/lib/api_reference/models/create_invoice_line_item_params.rb +128 -0
  122. data/lib/api_reference/models/create_one_off_invoice_params.rb +255 -0
  123. data/lib/api_reference/models/create_subscription_alert_request_params.rb +163 -0
  124. data/lib/api_reference/models/created_invoice.rb +851 -0
  125. data/lib/api_reference/models/credit_block.rb +231 -0
  126. data/lib/api_reference/models/credit_block_allocation.rb +140 -0
  127. data/lib/api_reference/models/credit_block_expiry_ledger_entry.rb +301 -0
  128. data/lib/api_reference/models/credit_block_invoices_response.rb +91 -0
  129. data/lib/api_reference/models/credit_block_source.rb +43 -0
  130. data/lib/api_reference/models/credit_ledger_entries.rb +109 -0
  131. data/lib/api_reference/models/credit_note.rb +338 -0
  132. data/lib/api_reference/models/credit_note_discount.rb +152 -0
  133. data/lib/api_reference/models/credit_note_discount_applies_to_price.rb +104 -0
  134. data/lib/api_reference/models/credit_note_line_item.rb +244 -0
  135. data/lib/api_reference/models/credit_note_line_item_discount.rb +173 -0
  136. data/lib/api_reference/models/credit_note_line_item_params.rb +116 -0
  137. data/lib/api_reference/models/credit_note_summary.rb +181 -0
  138. data/lib/api_reference/models/credit_note_tiny.rb +86 -0
  139. data/lib/api_reference/models/credit_notes.rb +92 -0
  140. data/lib/api_reference/models/cumulative_grouped_allocation_config.rb +94 -0
  141. data/lib/api_reference/models/cumulative_grouped_allocation_config1.rb +120 -0
  142. data/lib/api_reference/models/cumulative_grouped_allocation_price.rb +588 -0
  143. data/lib/api_reference/models/cumulative_grouped_bulk_config.rb +77 -0
  144. data/lib/api_reference/models/cumulative_grouped_bulk_config1.rb +103 -0
  145. data/lib/api_reference/models/cumulative_grouped_bulk_dimension_value.rb +105 -0
  146. data/lib/api_reference/models/cumulative_grouped_bulk_price.rb +588 -0
  147. data/lib/api_reference/models/custom_expiration.rb +104 -0
  148. data/lib/api_reference/models/customer.rb +511 -0
  149. data/lib/api_reference/models/customer_balance_transaction.rb +226 -0
  150. data/lib/api_reference/models/customer_balance_transactions.rb +92 -0
  151. data/lib/api_reference/models/customer_costs.rb +81 -0
  152. data/lib/api_reference/models/customer_credit_balance.rb +231 -0
  153. data/lib/api_reference/models/customer_credit_balances.rb +92 -0
  154. data/lib/api_reference/models/customer_hierarchy.rb +93 -0
  155. data/lib/api_reference/models/customer_hierarchy2.rb +121 -0
  156. data/lib/api_reference/models/customer_hierarchy_config.rb +92 -0
  157. data/lib/api_reference/models/customer_minified.rb +107 -0
  158. data/lib/api_reference/models/customer_tax_id.rb +224 -0
  159. data/lib/api_reference/models/customers.rb +92 -0
  160. data/lib/api_reference/models/daily_credit_allowance_config.rb +119 -0
  161. data/lib/api_reference/models/daily_credit_allowance_config1.rb +150 -0
  162. data/lib/api_reference/models/daily_credit_allowance_matrix_value.rb +93 -0
  163. data/lib/api_reference/models/daily_credit_allowance_price.rb +588 -0
  164. data/lib/api_reference/models/date_type.rb +36 -0
  165. data/lib/api_reference/models/deactivate_license.rb +65 -0
  166. data/lib/api_reference/models/debug.rb +82 -0
  167. data/lib/api_reference/models/decrement_ledger_entry.rb +342 -0
  168. data/lib/api_reference/models/deprecated_event_result.rb +74 -0
  169. data/lib/api_reference/models/dimensional_price_configuration.rb +108 -0
  170. data/lib/api_reference/models/dimensional_price_group.rb +134 -0
  171. data/lib/api_reference/models/dimensional_price_groups.rb +92 -0
  172. data/lib/api_reference/models/discount_override.rb +116 -0
  173. data/lib/api_reference/models/discount_type.rb +40 -0
  174. data/lib/api_reference/models/discount_type1.rb +36 -0
  175. data/lib/api_reference/models/duplicate_resource_creation_error.rb +101 -0
  176. data/lib/api_reference/models/duration_unit.rb +36 -0
  177. data/lib/api_reference/models/duration_unit1.rb +36 -0
  178. data/lib/api_reference/models/duration_unit3.rb +48 -0
  179. data/lib/api_reference/models/edit_adjustment_interval_params.rb +130 -0
  180. data/lib/api_reference/models/edit_customer.rb +351 -0
  181. data/lib/api_reference/models/edit_dimensional_price_group.rb +86 -0
  182. data/lib/api_reference/models/edit_plan.rb +91 -0
  183. data/lib/api_reference/models/edit_price_interval_params.rb +237 -0
  184. data/lib/api_reference/models/effective_time.rb +26 -0
  185. data/lib/api_reference/models/end_of_term.rb +26 -0
  186. data/lib/api_reference/models/entry_status.rb +36 -0
  187. data/lib/api_reference/models/entry_type.rb +56 -0
  188. data/lib/api_reference/models/evaluate_multiple_price_resource.rb +81 -0
  189. data/lib/api_reference/models/evaluate_multiple_prices_body.rb +129 -0
  190. data/lib/api_reference/models/evaluate_multiple_prices_with_preview_events_body.rb +148 -0
  191. data/lib/api_reference/models/evaluate_price_body.rb +153 -0
  192. data/lib/api_reference/models/evaluate_price_group.rb +120 -0
  193. data/lib/api_reference/models/evaluate_price_resource.rb +81 -0
  194. data/lib/api_reference/models/evaluate_price_resource_for_multiple_price.rb +130 -0
  195. data/lib/api_reference/models/event.rb +149 -0
  196. data/lib/api_reference/models/event_output_config.rb +90 -0
  197. data/lib/api_reference/models/event_output_config1.rb +104 -0
  198. data/lib/api_reference/models/event_output_price.rb +585 -0
  199. data/lib/api_reference/models/event_search_criteria.rb +106 -0
  200. data/lib/api_reference/models/event_volume.rb +107 -0
  201. data/lib/api_reference/models/event_volume_params.rb +115 -0
  202. data/lib/api_reference/models/event_volumes.rb +81 -0
  203. data/lib/api_reference/models/events.rb +81 -0
  204. data/lib/api_reference/models/expiration_change_ledger_entry.rb +324 -0
  205. data/lib/api_reference/models/expires_after_unit.rb +36 -0
  206. data/lib/api_reference/models/external_connection_name.rb +44 -0
  207. data/lib/api_reference/models/external_connection_name1.rb +48 -0
  208. data/lib/api_reference/models/external_marketplace.rb +40 -0
  209. data/lib/api_reference/models/feature_not_available_error.rb +101 -0
  210. data/lib/api_reference/models/fetch_customer_credit_blocks_query_params.rb +181 -0
  211. data/lib/api_reference/models/fetch_customer_credit_ledger_query_params.rb +198 -0
  212. data/lib/api_reference/models/fetch_license_by_external_id.rb +72 -0
  213. data/lib/api_reference/models/fetch_subscription_schedule_query_params.rb +157 -0
  214. data/lib/api_reference/models/fetch_upcoming_invoice_params.rb +61 -0
  215. data/lib/api_reference/models/field.rb +48 -0
  216. data/lib/api_reference/models/filter_rule.rb +92 -0
  217. data/lib/api_reference/models/fixed_fee_quantity_change.rb +116 -0
  218. data/lib/api_reference/models/fixed_fee_quantity_schedule_entry.rb +145 -0
  219. data/lib/api_reference/models/fixed_fee_quantity_transition.rb +124 -0
  220. data/lib/api_reference/models/granularity.rb +26 -0
  221. data/lib/api_reference/models/grouped_allocation_config.rb +79 -0
  222. data/lib/api_reference/models/grouped_allocation_config1.rb +105 -0
  223. data/lib/api_reference/models/grouped_allocation_price.rb +587 -0
  224. data/lib/api_reference/models/grouped_subscription_usage.rb +114 -0
  225. data/lib/api_reference/models/grouped_subscription_usage_record.rb +149 -0
  226. data/lib/api_reference/models/grouped_tiered_config.rb +78 -0
  227. data/lib/api_reference/models/grouped_tiered_config1.rb +104 -0
  228. data/lib/api_reference/models/grouped_tiered_package_price.rb +588 -0
  229. data/lib/api_reference/models/grouped_tiered_package_pricing_config.rb +89 -0
  230. data/lib/api_reference/models/grouped_tiered_package_pricing_config1.rb +119 -0
  231. data/lib/api_reference/models/grouped_tiered_package_tier_item.rb +92 -0
  232. data/lib/api_reference/models/grouped_tiered_price.rb +586 -0
  233. data/lib/api_reference/models/grouped_tiered_tier.rb +92 -0
  234. data/lib/api_reference/models/grouped_with_metered_minimum_config.rb +127 -0
  235. data/lib/api_reference/models/grouped_with_metered_minimum_config1.rb +173 -0
  236. data/lib/api_reference/models/grouped_with_metered_minimum_price.rb +588 -0
  237. data/lib/api_reference/models/grouped_with_metered_minimum_scaling_factor_item.rb +92 -0
  238. data/lib/api_reference/models/grouped_with_metered_minimum_unit_amount_item.rb +91 -0
  239. data/lib/api_reference/models/grouped_with_min_max_thresholds_config.rb +90 -0
  240. data/lib/api_reference/models/grouped_with_min_max_thresholds_config1.rb +120 -0
  241. data/lib/api_reference/models/grouped_with_min_max_thresholds_price.rb +588 -0
  242. data/lib/api_reference/models/grouped_with_prorated_minimum_config.rb +78 -0
  243. data/lib/api_reference/models/grouped_with_prorated_minimum_config1.rb +104 -0
  244. data/lib/api_reference/models/grouped_with_prorated_minimum_price.rb +588 -0
  245. data/lib/api_reference/models/increment_credit_ledger_entry_invoice_settings.rb +197 -0
  246. data/lib/api_reference/models/increment_ledger_entry.rb +322 -0
  247. data/lib/api_reference/models/ingest_event.rb +127 -0
  248. data/lib/api_reference/models/ingest_event_idempotency_key_only.rb +75 -0
  249. data/lib/api_reference/models/ingest_query_params.rb +75 -0
  250. data/lib/api_reference/models/ingest_request_body.rb +69 -0
  251. data/lib/api_reference/models/ingestion_response.rb +97 -0
  252. data/lib/api_reference/models/invoice.rb +843 -0
  253. data/lib/api_reference/models/invoice_line_item.rb +359 -0
  254. data/lib/api_reference/models/invoice_line_item_params.rb +157 -0
  255. data/lib/api_reference/models/invoice_minified.rb +112 -0
  256. data/lib/api_reference/models/invoice_source.rb +40 -0
  257. data/lib/api_reference/models/invoice_summary.rb +525 -0
  258. data/lib/api_reference/models/invoice_summarys.rb +92 -0
  259. data/lib/api_reference/models/invoice_tiny.rb +86 -0
  260. data/lib/api_reference/models/invoices.rb +92 -0
  261. data/lib/api_reference/models/issue_invoice_request_params.rb +66 -0
  262. data/lib/api_reference/models/item.rb +154 -0
  263. data/lib/api_reference/models/item_external_connection.rb +110 -0
  264. data/lib/api_reference/models/item_slim.rb +105 -0
  265. data/lib/api_reference/models/items.rb +92 -0
  266. data/lib/api_reference/models/license_api_resource.rb +147 -0
  267. data/lib/api_reference/models/license_api_resources.rb +92 -0
  268. data/lib/api_reference/models/license_type.rb +119 -0
  269. data/lib/api_reference/models/license_type_minified.rb +86 -0
  270. data/lib/api_reference/models/license_types.rb +92 -0
  271. data/lib/api_reference/models/license_usage.rb +203 -0
  272. data/lib/api_reference/models/license_usage_by_external_id_query_params.rb +133 -0
  273. data/lib/api_reference/models/license_usage_by_type_query_params.rb +132 -0
  274. data/lib/api_reference/models/license_usage_query_params.rb +110 -0
  275. data/lib/api_reference/models/license_usages.rb +92 -0
  276. data/lib/api_reference/models/list_alerts_query_params.rb +189 -0
  277. data/lib/api_reference/models/list_credit_notes_params.rb +157 -0
  278. data/lib/api_reference/models/list_customer_balance_transactions_query_params.rb +158 -0
  279. data/lib/api_reference/models/list_customers_query_params.rb +157 -0
  280. data/lib/api_reference/models/list_invoices_params.rb +345 -0
  281. data/lib/api_reference/models/list_licenses_params.rb +125 -0
  282. data/lib/api_reference/models/list_metrics_query_params.rb +157 -0
  283. data/lib/api_reference/models/list_plans_query_params.rb +163 -0
  284. data/lib/api_reference/models/list_subscription_changes_query_params.rb +112 -0
  285. data/lib/api_reference/models/list_subscriptions_query_params.rb +258 -0
  286. data/lib/api_reference/models/map_item_request_params.rb +103 -0
  287. data/lib/api_reference/models/mark_as_paid_request_params.rb +85 -0
  288. data/lib/api_reference/models/matrix_cell.rb +108 -0
  289. data/lib/api_reference/models/matrix_config.rb +119 -0
  290. data/lib/api_reference/models/matrix_price.rb +584 -0
  291. data/lib/api_reference/models/matrix_sub_line_item.rb +173 -0
  292. data/lib/api_reference/models/matrix_value.rb +92 -0
  293. data/lib/api_reference/models/matrix_with_allocation_config.rb +99 -0
  294. data/lib/api_reference/models/matrix_with_allocation_config1.rb +133 -0
  295. data/lib/api_reference/models/matrix_with_allocation_price.rb +588 -0
  296. data/lib/api_reference/models/matrix_with_allocation_value_item.rb +94 -0
  297. data/lib/api_reference/models/matrix_with_display_name_config.rb +77 -0
  298. data/lib/api_reference/models/matrix_with_display_name_config1.rb +103 -0
  299. data/lib/api_reference/models/matrix_with_display_name_price.rb +588 -0
  300. data/lib/api_reference/models/matrix_with_display_name_unit_amount_item.rb +105 -0
  301. data/lib/api_reference/models/matrix_with_threshold_discounts_config.rb +130 -0
  302. data/lib/api_reference/models/matrix_with_threshold_discounts_config1.rb +157 -0
  303. data/lib/api_reference/models/matrix_with_threshold_discounts_price.rb +588 -0
  304. data/lib/api_reference/models/max_group_tiered_package_config.rb +90 -0
  305. data/lib/api_reference/models/max_group_tiered_package_config1.rb +120 -0
  306. data/lib/api_reference/models/max_group_tiered_package_price.rb +588 -0
  307. data/lib/api_reference/models/max_group_tiered_tier_item.rb +92 -0
  308. data/lib/api_reference/models/maximum.rb +135 -0
  309. data/lib/api_reference/models/maximum_interval.rb +177 -0
  310. data/lib/api_reference/models/metered_allowance_config.rb +130 -0
  311. data/lib/api_reference/models/metered_allowance_config1.rb +152 -0
  312. data/lib/api_reference/models/metered_allowance_price.rb +587 -0
  313. data/lib/api_reference/models/metric_group.rb +105 -0
  314. data/lib/api_reference/models/minimum.rb +135 -0
  315. data/lib/api_reference/models/minimum_composite_config.rb +73 -0
  316. data/lib/api_reference/models/minimum_composite_config1.rb +87 -0
  317. data/lib/api_reference/models/minimum_composite_price.rb +587 -0
  318. data/lib/api_reference/models/minimum_interval.rb +177 -0
  319. data/lib/api_reference/models/monetary_amount_discount_adjustment.rb +219 -0
  320. data/lib/api_reference/models/monetary_maximum_adjustment.rb +218 -0
  321. data/lib/api_reference/models/monetary_minimum_adjustment.rb +231 -0
  322. data/lib/api_reference/models/monetary_percentage_discount_adjustment.rb +219 -0
  323. data/lib/api_reference/models/monetary_tiered_percentage_discount_adjustment.rb +230 -0
  324. data/lib/api_reference/models/monetary_usage_discount_adjustment.rb +218 -0
  325. data/lib/api_reference/models/mutated_subscription.rb +683 -0
  326. data/lib/api_reference/models/new_accounting_sync_configuration.rb +98 -0
  327. data/lib/api_reference/models/new_allocation_price.rb +221 -0
  328. data/lib/api_reference/models/new_amount_discount.rb +202 -0
  329. data/lib/api_reference/models/new_anrok_configuration.rb +100 -0
  330. data/lib/api_reference/models/new_avalara_tax_configuration.rb +114 -0
  331. data/lib/api_reference/models/new_backfill.rb +165 -0
  332. data/lib/api_reference/models/new_billable_metric.rb +101 -0
  333. data/lib/api_reference/models/new_billing_cycle_configuration.rb +104 -0
  334. data/lib/api_reference/models/new_coupon.rb +123 -0
  335. data/lib/api_reference/models/new_coupon_amount_discount.rb +103 -0
  336. data/lib/api_reference/models/new_coupon_percentage_discount.rb +103 -0
  337. data/lib/api_reference/models/new_customer.rb +333 -0
  338. data/lib/api_reference/models/new_customer_balance_transaction.rb +81 -0
  339. data/lib/api_reference/models/new_dimensional_price_configuration.rb +126 -0
  340. data/lib/api_reference/models/new_dimensional_price_group.rb +115 -0
  341. data/lib/api_reference/models/new_floating_bulk_price.rb +333 -0
  342. data/lib/api_reference/models/new_floating_bulk_with_filters_price.rb +336 -0
  343. data/lib/api_reference/models/new_floating_bulk_with_proration_price.rb +336 -0
  344. data/lib/api_reference/models/new_floating_cumulative_grouped_allocation_price.rb +337 -0
  345. data/lib/api_reference/models/new_floating_cumulative_grouped_bulk_price.rb +337 -0
  346. data/lib/api_reference/models/new_floating_daily_credit_allowance_price.rb +337 -0
  347. data/lib/api_reference/models/new_floating_event_output_price.rb +334 -0
  348. data/lib/api_reference/models/new_floating_grouped_allocation_price.rb +336 -0
  349. data/lib/api_reference/models/new_floating_grouped_tiered_package_price.rb +337 -0
  350. data/lib/api_reference/models/new_floating_grouped_tiered_price.rb +335 -0
  351. data/lib/api_reference/models/new_floating_grouped_with_metered_minimum_price.rb +337 -0
  352. data/lib/api_reference/models/new_floating_grouped_with_min_max_thresholds_price.rb +337 -0
  353. data/lib/api_reference/models/new_floating_grouped_with_prorated_minimum_price.rb +337 -0
  354. data/lib/api_reference/models/new_floating_matrix_price.rb +333 -0
  355. data/lib/api_reference/models/new_floating_matrix_with_allocation_price.rb +337 -0
  356. data/lib/api_reference/models/new_floating_matrix_with_display_name_price.rb +337 -0
  357. data/lib/api_reference/models/new_floating_matrix_with_threshold_discounts_price.rb +337 -0
  358. data/lib/api_reference/models/new_floating_max_group_tiered_package_price.rb +337 -0
  359. data/lib/api_reference/models/new_floating_metered_allowance_price.rb +336 -0
  360. data/lib/api_reference/models/new_floating_minimum_composite_price.rb +336 -0
  361. data/lib/api_reference/models/new_floating_package_price.rb +333 -0
  362. data/lib/api_reference/models/new_floating_package_with_allocation_price.rb +337 -0
  363. data/lib/api_reference/models/new_floating_percent_composite_price.rb +334 -0
  364. data/lib/api_reference/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +338 -0
  365. data/lib/api_reference/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +338 -0
  366. data/lib/api_reference/models/new_floating_threshold_total_amount_price.rb +337 -0
  367. data/lib/api_reference/models/new_floating_tiered_package_price.rb +336 -0
  368. data/lib/api_reference/models/new_floating_tiered_package_with_minimum_price.rb +337 -0
  369. data/lib/api_reference/models/new_floating_tiered_price.rb +333 -0
  370. data/lib/api_reference/models/new_floating_tiered_with_minimum_price.rb +336 -0
  371. data/lib/api_reference/models/new_floating_tiered_with_proration_price.rb +336 -0
  372. data/lib/api_reference/models/new_floating_unit_price.rb +333 -0
  373. data/lib/api_reference/models/new_floating_unit_with_percent_price.rb +336 -0
  374. data/lib/api_reference/models/new_floating_unit_with_proration_price.rb +336 -0
  375. data/lib/api_reference/models/new_item.rb +74 -0
  376. data/lib/api_reference/models/new_license.rb +108 -0
  377. data/lib/api_reference/models/new_license_allocation.rb +97 -0
  378. data/lib/api_reference/models/new_license_allocation_unit_price.rb +330 -0
  379. data/lib/api_reference/models/new_license_type.rb +69 -0
  380. data/lib/api_reference/models/new_license_type_configuration.rb +78 -0
  381. data/lib/api_reference/models/new_maximum.rb +202 -0
  382. data/lib/api_reference/models/new_minimum.rb +215 -0
  383. data/lib/api_reference/models/new_numeral_configuration.rb +100 -0
  384. data/lib/api_reference/models/new_percentage_discount.rb +202 -0
  385. data/lib/api_reference/models/new_plan.rb +210 -0
  386. data/lib/api_reference/models/new_plan_bulk_price.rb +310 -0
  387. data/lib/api_reference/models/new_plan_bulk_with_filters_price.rb +313 -0
  388. data/lib/api_reference/models/new_plan_bulk_with_proration_price.rb +313 -0
  389. data/lib/api_reference/models/new_plan_cumulative_grouped_allocation_price.rb +314 -0
  390. data/lib/api_reference/models/new_plan_cumulative_grouped_bulk_price.rb +314 -0
  391. data/lib/api_reference/models/new_plan_daily_credit_allowance_price.rb +314 -0
  392. data/lib/api_reference/models/new_plan_event_output_price.rb +311 -0
  393. data/lib/api_reference/models/new_plan_grouped_allocation_price.rb +313 -0
  394. data/lib/api_reference/models/new_plan_grouped_tiered_package_price.rb +314 -0
  395. data/lib/api_reference/models/new_plan_grouped_tiered_price.rb +312 -0
  396. data/lib/api_reference/models/new_plan_grouped_with_metered_minimum_price.rb +314 -0
  397. data/lib/api_reference/models/new_plan_grouped_with_min_max_thresholds_price.rb +314 -0
  398. data/lib/api_reference/models/new_plan_grouped_with_prorated_minimum_price.rb +314 -0
  399. data/lib/api_reference/models/new_plan_matrix_price.rb +310 -0
  400. data/lib/api_reference/models/new_plan_matrix_with_allocation_price.rb +314 -0
  401. data/lib/api_reference/models/new_plan_matrix_with_display_name_price.rb +314 -0
  402. data/lib/api_reference/models/new_plan_matrix_with_threshold_discounts_price.rb +314 -0
  403. data/lib/api_reference/models/new_plan_max_group_tiered_package_price.rb +314 -0
  404. data/lib/api_reference/models/new_plan_metered_allowance_price.rb +313 -0
  405. data/lib/api_reference/models/new_plan_minimum_composite_price.rb +313 -0
  406. data/lib/api_reference/models/new_plan_package_price.rb +310 -0
  407. data/lib/api_reference/models/new_plan_package_with_allocation_price.rb +314 -0
  408. data/lib/api_reference/models/new_plan_percent_composite_price.rb +311 -0
  409. data/lib/api_reference/models/new_plan_phase.rb +104 -0
  410. data/lib/api_reference/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +315 -0
  411. data/lib/api_reference/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +315 -0
  412. data/lib/api_reference/models/new_plan_threshold_total_amount_price.rb +314 -0
  413. data/lib/api_reference/models/new_plan_tiered_package_price.rb +313 -0
  414. data/lib/api_reference/models/new_plan_tiered_package_with_minimum_price.rb +314 -0
  415. data/lib/api_reference/models/new_plan_tiered_price.rb +310 -0
  416. data/lib/api_reference/models/new_plan_tiered_with_minimum_price.rb +313 -0
  417. data/lib/api_reference/models/new_plan_tiered_with_proration_price.rb +313 -0
  418. data/lib/api_reference/models/new_plan_unit_price.rb +310 -0
  419. data/lib/api_reference/models/new_plan_unit_with_percent_price.rb +313 -0
  420. data/lib/api_reference/models/new_plan_unit_with_proration_price.rb +313 -0
  421. data/lib/api_reference/models/new_plan_version.rb +197 -0
  422. data/lib/api_reference/models/new_portal_session.rb +78 -0
  423. data/lib/api_reference/models/new_reporting_configuration.rb +73 -0
  424. data/lib/api_reference/models/new_sphere_configuration.rb +100 -0
  425. data/lib/api_reference/models/new_stripe_tax_configuration.rb +100 -0
  426. data/lib/api_reference/models/new_subscription.rb +603 -0
  427. data/lib/api_reference/models/new_subscription_bulk_price.rb +310 -0
  428. data/lib/api_reference/models/new_subscription_bulk_with_filters_price.rb +313 -0
  429. data/lib/api_reference/models/new_subscription_bulk_with_proration_price.rb +313 -0
  430. data/lib/api_reference/models/new_subscription_cumulative_grouped_allocation_price.rb +314 -0
  431. data/lib/api_reference/models/new_subscription_cumulative_grouped_bulk_price.rb +314 -0
  432. data/lib/api_reference/models/new_subscription_daily_credit_allowance_price.rb +314 -0
  433. data/lib/api_reference/models/new_subscription_event_output_price.rb +311 -0
  434. data/lib/api_reference/models/new_subscription_grouped_allocation_price.rb +313 -0
  435. data/lib/api_reference/models/new_subscription_grouped_tiered_package_price.rb +314 -0
  436. data/lib/api_reference/models/new_subscription_grouped_tiered_price.rb +312 -0
  437. data/lib/api_reference/models/new_subscription_grouped_with_metered_minimum_price.rb +314 -0
  438. data/lib/api_reference/models/new_subscription_grouped_with_min_max_thresholds_price.rb +314 -0
  439. data/lib/api_reference/models/new_subscription_grouped_with_prorated_minimum_price.rb +314 -0
  440. data/lib/api_reference/models/new_subscription_matrix_price.rb +310 -0
  441. data/lib/api_reference/models/new_subscription_matrix_with_allocation_price.rb +314 -0
  442. data/lib/api_reference/models/new_subscription_matrix_with_display_name_price.rb +314 -0
  443. data/lib/api_reference/models/new_subscription_matrix_with_threshold_discounts_price.rb +314 -0
  444. data/lib/api_reference/models/new_subscription_max_group_tiered_package_price.rb +314 -0
  445. data/lib/api_reference/models/new_subscription_metered_allowance_price.rb +313 -0
  446. data/lib/api_reference/models/new_subscription_minimum_composite_price.rb +313 -0
  447. data/lib/api_reference/models/new_subscription_package_price.rb +310 -0
  448. data/lib/api_reference/models/new_subscription_package_with_allocation_price.rb +314 -0
  449. data/lib/api_reference/models/new_subscription_percent_composite_price.rb +311 -0
  450. data/lib/api_reference/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +315 -0
  451. data/lib/api_reference/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +315 -0
  452. data/lib/api_reference/models/new_subscription_threshold_total_amount_price.rb +314 -0
  453. data/lib/api_reference/models/new_subscription_tiered_package_price.rb +313 -0
  454. data/lib/api_reference/models/new_subscription_tiered_package_with_minimum_price.rb +314 -0
  455. data/lib/api_reference/models/new_subscription_tiered_price.rb +310 -0
  456. data/lib/api_reference/models/new_subscription_tiered_with_minimum_price.rb +313 -0
  457. data/lib/api_reference/models/new_subscription_tiered_with_proration_price.rb +313 -0
  458. data/lib/api_reference/models/new_subscription_unit_price.rb +310 -0
  459. data/lib/api_reference/models/new_subscription_unit_with_percent_price.rb +313 -0
  460. data/lib/api_reference/models/new_subscription_unit_with_proration_price.rb +313 -0
  461. data/lib/api_reference/models/new_tax_jar_configuration.rb +100 -0
  462. data/lib/api_reference/models/new_tiered_percentage_discount.rb +214 -0
  463. data/lib/api_reference/models/new_tiered_percentage_discount_tier.rb +118 -0
  464. data/lib/api_reference/models/new_top_up_invoice_settings.rb +117 -0
  465. data/lib/api_reference/models/new_top_up_invoice_settings2.rb +117 -0
  466. data/lib/api_reference/models/new_usage_discount.rb +202 -0
  467. data/lib/api_reference/models/operator.rb +36 -0
  468. data/lib/api_reference/models/other_sub_line_item.rb +144 -0
  469. data/lib/api_reference/models/package_config.rb +93 -0
  470. data/lib/api_reference/models/package_price.rb +584 -0
  471. data/lib/api_reference/models/package_with_allocation_config.rb +79 -0
  472. data/lib/api_reference/models/package_with_allocation_config1.rb +105 -0
  473. data/lib/api_reference/models/package_with_allocation_price.rb +588 -0
  474. data/lib/api_reference/models/pagination_metadata.rb +106 -0
  475. data/lib/api_reference/models/pay_invoice_params.rb +62 -0
  476. data/lib/api_reference/models/payment_attempt.rb +184 -0
  477. data/lib/api_reference/models/payment_configuration.rb +95 -0
  478. data/lib/api_reference/models/payment_configuration_item.rb +126 -0
  479. data/lib/api_reference/models/payment_method.rb +188 -0
  480. data/lib/api_reference/models/payment_method_type.rb +49 -0
  481. data/lib/api_reference/models/payment_provider.rb +36 -0
  482. data/lib/api_reference/models/payment_provider1.rb +52 -0
  483. data/lib/api_reference/models/per_price_cost.rb +145 -0
  484. data/lib/api_reference/models/percent_composite_config.rb +109 -0
  485. data/lib/api_reference/models/percent_composite_config1.rb +112 -0
  486. data/lib/api_reference/models/percent_composite_price.rb +585 -0
  487. data/lib/api_reference/models/percentage_discount.rb +151 -0
  488. data/lib/api_reference/models/percentage_discount_creation_params.rb +104 -0
  489. data/lib/api_reference/models/percentage_discount_interval.rb +188 -0
  490. data/lib/api_reference/models/percentage_tier.rb +122 -0
  491. data/lib/api_reference/models/ping_response.rb +73 -0
  492. data/lib/api_reference/models/plan.rb +501 -0
  493. data/lib/api_reference/models/plan_minified.rb +125 -0
  494. data/lib/api_reference/models/plan_minified_with_version.rb +141 -0
  495. data/lib/api_reference/models/plan_phase.rb +244 -0
  496. data/lib/api_reference/models/plan_phase_amount_discount_adjustment.rb +221 -0
  497. data/lib/api_reference/models/plan_phase_maximum_adjustment.rb +221 -0
  498. data/lib/api_reference/models/plan_phase_minimum_adjustment.rb +233 -0
  499. data/lib/api_reference/models/plan_phase_percentage_discount_adjustment.rb +221 -0
  500. data/lib/api_reference/models/plan_phase_tiered_percentage_discount_adjustment.rb +233 -0
  501. data/lib/api_reference/models/plan_phase_usage_discount_adjustment.rb +221 -0
  502. data/lib/api_reference/models/plan_version.rb +172 -0
  503. data/lib/api_reference/models/plan_version_change.rb +143 -0
  504. data/lib/api_reference/models/plan_version_changes.rb +92 -0
  505. data/lib/api_reference/models/plan_version_phase.rb +163 -0
  506. data/lib/api_reference/models/plans.rb +92 -0
  507. data/lib/api_reference/models/portal_session.rb +124 -0
  508. data/lib/api_reference/models/preview_event.rb +115 -0
  509. data/lib/api_reference/models/price_evaluation_request.rb +157 -0
  510. data/lib/api_reference/models/price_filter.rb +116 -0
  511. data/lib/api_reference/models/price_group.rb +132 -0
  512. data/lib/api_reference/models/price_interval.rb +319 -0
  513. data/lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb +112 -0
  514. data/lib/api_reference/models/price_type.rb +48 -0
  515. data/lib/api_reference/models/price_type6.rb +40 -0
  516. data/lib/api_reference/models/prices.rb +109 -0
  517. data/lib/api_reference/models/product.rb +123 -0
  518. data/lib/api_reference/models/provider_type.rb +36 -0
  519. data/lib/api_reference/models/quantity_only_override_price.rb +147 -0
  520. data/lib/api_reference/models/reason.rb +44 -0
  521. data/lib/api_reference/models/reason1.rb +44 -0
  522. data/lib/api_reference/models/redeem_coupon_params.rb +126 -0
  523. data/lib/api_reference/models/remove_plan_adjustment_params.rb +74 -0
  524. data/lib/api_reference/models/remove_plan_price_params.rb +74 -0
  525. data/lib/api_reference/models/remove_subscription_adjustment_params.rb +74 -0
  526. data/lib/api_reference/models/remove_subscription_price_params.rb +90 -0
  527. data/lib/api_reference/models/replace_plan_adjustment_params.rb +108 -0
  528. data/lib/api_reference/models/replace_plan_price_params.rb +112 -0
  529. data/lib/api_reference/models/replace_subscription_adjustment_params.rb +108 -0
  530. data/lib/api_reference/models/replace_subscription_price_params.rb +203 -0
  531. data/lib/api_reference/models/reporting_configuration.rb +87 -0
  532. data/lib/api_reference/models/request_too_large_error.rb +101 -0
  533. data/lib/api_reference/models/request_validation_error.rb +112 -0
  534. data/lib/api_reference/models/resource_not_found_error.rb +99 -0
  535. data/lib/api_reference/models/resource_too_large_error.rb +101 -0
  536. data/lib/api_reference/models/scalable_matrix_with_tiered_pricing_config.rb +112 -0
  537. data/lib/api_reference/models/scalable_matrix_with_tiered_pricing_config1.rb +146 -0
  538. data/lib/api_reference/models/scalable_matrix_with_tiered_pricing_price.rb +589 -0
  539. data/lib/api_reference/models/scalable_matrix_with_tiered_scaling_factor.rb +109 -0
  540. data/lib/api_reference/models/scalable_matrix_with_tiered_tier_entry.rb +92 -0
  541. data/lib/api_reference/models/scalable_matrix_with_unit_pricing_config.rb +125 -0
  542. data/lib/api_reference/models/scalable_matrix_with_unit_pricing_config1.rb +155 -0
  543. data/lib/api_reference/models/scalable_matrix_with_unit_pricing_price.rb +589 -0
  544. data/lib/api_reference/models/scalable_matrix_with_unit_scaling_factor.rb +109 -0
  545. data/lib/api_reference/models/set_default_version.rb +60 -0
  546. data/lib/api_reference/models/start_of_term.rb +26 -0
  547. data/lib/api_reference/models/status.rb +40 -0
  548. data/lib/api_reference/models/status1.rb +48 -0
  549. data/lib/api_reference/models/status10.rb +40 -0
  550. data/lib/api_reference/models/status11.rb +48 -0
  551. data/lib/api_reference/models/status12.rb +40 -0
  552. data/lib/api_reference/models/status13.rb +40 -0
  553. data/lib/api_reference/models/status14.rb +40 -0
  554. data/lib/api_reference/models/status17.rb +37 -0
  555. data/lib/api_reference/models/status18.rb +49 -0
  556. data/lib/api_reference/models/status23.rb +48 -0
  557. data/lib/api_reference/models/status28.rb +40 -0
  558. data/lib/api_reference/models/status3.rb +36 -0
  559. data/lib/api_reference/models/status7.rb +36 -0
  560. data/lib/api_reference/models/sub_line_item_grouping.rb +106 -0
  561. data/lib/api_reference/models/sub_line_item_matrix_config.rb +89 -0
  562. data/lib/api_reference/models/subscription.rb +680 -0
  563. data/lib/api_reference/models/subscription_change_list_response.rb +152 -0
  564. data/lib/api_reference/models/subscription_change_list_responses.rb +92 -0
  565. data/lib/api_reference/models/subscription_change_minified.rb +86 -0
  566. data/lib/api_reference/models/subscription_change_response.rb +217 -0
  567. data/lib/api_reference/models/subscription_costs.rb +81 -0
  568. data/lib/api_reference/models/subscription_minified.rb +86 -0
  569. data/lib/api_reference/models/subscription_plan_change.rb +502 -0
  570. data/lib/api_reference/models/subscription_schedule_item.rb +122 -0
  571. data/lib/api_reference/models/subscription_schedule_items.rb +92 -0
  572. data/lib/api_reference/models/subscription_trial_info.rb +96 -0
  573. data/lib/api_reference/models/subscription_usage_request_params.rb +207 -0
  574. data/lib/api_reference/models/subscriptions.rb +92 -0
  575. data/lib/api_reference/models/tax_amount.rb +123 -0
  576. data/lib/api_reference/models/threshold.rb +90 -0
  577. data/lib/api_reference/models/threshold_discount_group.rb +147 -0
  578. data/lib/api_reference/models/threshold_override.rb +121 -0
  579. data/lib/api_reference/models/threshold_override_params.rb +97 -0
  580. data/lib/api_reference/models/threshold_total_amount_config.rb +83 -0
  581. data/lib/api_reference/models/threshold_total_amount_config1.rb +101 -0
  582. data/lib/api_reference/models/threshold_total_amount_price.rb +588 -0
  583. data/lib/api_reference/models/tier.rb +105 -0
  584. data/lib/api_reference/models/tier_sub_line_item.rb +160 -0
  585. data/lib/api_reference/models/tier_sub_line_item_tier_config.rb +119 -0
  586. data/lib/api_reference/models/tiered_config.rb +98 -0
  587. data/lib/api_reference/models/tiered_conversion_rate_config.rb +81 -0
  588. data/lib/api_reference/models/tiered_package_price.rb +587 -0
  589. data/lib/api_reference/models/tiered_package_pricing_config.rb +83 -0
  590. data/lib/api_reference/models/tiered_package_pricing_config1.rb +109 -0
  591. data/lib/api_reference/models/tiered_package_pricing_with_minimum_config.rb +79 -0
  592. data/lib/api_reference/models/tiered_package_pricing_with_minimum_config1.rb +105 -0
  593. data/lib/api_reference/models/tiered_package_tier_item.rb +92 -0
  594. data/lib/api_reference/models/tiered_package_with_minimum_price.rb +588 -0
  595. data/lib/api_reference/models/tiered_package_with_minimum_tier_item.rb +106 -0
  596. data/lib/api_reference/models/tiered_percentage_discount.rb +164 -0
  597. data/lib/api_reference/models/tiered_percentage_discount_interval.rb +201 -0
  598. data/lib/api_reference/models/tiered_price.rb +584 -0
  599. data/lib/api_reference/models/tiered_pricing_with_minimum_config.rb +93 -0
  600. data/lib/api_reference/models/tiered_pricing_with_minimum_config1.rb +111 -0
  601. data/lib/api_reference/models/tiered_pricing_with_minimum_tier_item.rb +106 -0
  602. data/lib/api_reference/models/tiered_total_threshold.rb +90 -0
  603. data/lib/api_reference/models/tiered_with_minimum_price.rb +587 -0
  604. data/lib/api_reference/models/tiered_with_proration_config.rb +70 -0
  605. data/lib/api_reference/models/tiered_with_proration_config1.rb +88 -0
  606. data/lib/api_reference/models/tiered_with_proration_price.rb +587 -0
  607. data/lib/api_reference/models/tiered_with_proration_tier.rb +92 -0
  608. data/lib/api_reference/models/too_many_results_error.rb +101 -0
  609. data/lib/api_reference/models/top_up.rb +149 -0
  610. data/lib/api_reference/models/top_up_invoice_settings.rb +117 -0
  611. data/lib/api_reference/models/top_up_invoice_settings2.rb +117 -0
  612. data/lib/api_reference/models/top_ups.rb +92 -0
  613. data/lib/api_reference/models/trial_config.rb +104 -0
  614. data/lib/api_reference/models/trial_discount.rb +161 -0
  615. data/lib/api_reference/models/trial_end_date.rb +26 -0
  616. data/lib/api_reference/models/trigger_subscription_phase_params.rb +84 -0
  617. data/lib/api_reference/models/type.rb +40 -0
  618. data/lib/api_reference/models/type1.rb +36 -0
  619. data/lib/api_reference/models/type2.rb +26 -0
  620. data/lib/api_reference/models/type3.rb +36 -0
  621. data/lib/api_reference/models/type4.rb +36 -0
  622. data/lib/api_reference/models/type5.rb +492 -0
  623. data/lib/api_reference/models/type6.rb +40 -0
  624. data/lib/api_reference/models/type7.rb +36 -0
  625. data/lib/api_reference/models/ungrouped_subscription_usage.rb +99 -0
  626. data/lib/api_reference/models/ungrouped_subscription_usage_record.rb +133 -0
  627. data/lib/api_reference/models/unit_config.rb +85 -0
  628. data/lib/api_reference/models/unit_conversion_rate_config.rb +80 -0
  629. data/lib/api_reference/models/unit_price.rb +584 -0
  630. data/lib/api_reference/models/unit_with_percent_config.rb +68 -0
  631. data/lib/api_reference/models/unit_with_percent_config1.rb +90 -0
  632. data/lib/api_reference/models/unit_with_percent_price.rb +587 -0
  633. data/lib/api_reference/models/unit_with_proration_config.rb +60 -0
  634. data/lib/api_reference/models/unit_with_proration_config1.rb +74 -0
  635. data/lib/api_reference/models/unit_with_proration_price.rb +587 -0
  636. data/lib/api_reference/models/unschedule_fixed_fee_quantity_change_params.rb +60 -0
  637. data/lib/api_reference/models/upcoming_invoice.rb +838 -0
  638. data/lib/api_reference/models/update_alert_query_params.rb +65 -0
  639. data/lib/api_reference/models/update_alert_request_params.rb +116 -0
  640. data/lib/api_reference/models/update_invoice_request_params.rb +145 -0
  641. data/lib/api_reference/models/update_metric_request_params.rb +66 -0
  642. data/lib/api_reference/models/update_price_request_params.rb +66 -0
  643. data/lib/api_reference/models/update_subscription_params.rb +137 -0
  644. data/lib/api_reference/models/update_trial_request_params.rb +94 -0
  645. data/lib/api_reference/models/url_not_found.rb +101 -0
  646. data/lib/api_reference/models/usage.rb +131 -0
  647. data/lib/api_reference/models/usage_discount.rb +129 -0
  648. data/lib/api_reference/models/usage_discount_creation_params.rb +82 -0
  649. data/lib/api_reference/models/usage_discount_interval.rb +188 -0
  650. data/lib/api_reference/models/validation_error.rb +86 -0
  651. data/lib/api_reference/models/view_mode.rb +36 -0
  652. data/lib/api_reference/models/void_initiated_ledger_entry.rb +356 -0
  653. data/lib/api_reference/models/void_ledger_entry.rb +334 -0
  654. data/lib/api_reference/models/void_reason.rb +26 -0
  655. data/lib/api_reference/utilities/date_time_helper.rb +11 -0
  656. data/lib/api_reference/utilities/file_wrapper.rb +28 -0
  657. data/lib/api_reference/utilities/union_type_lookup.rb +1433 -0
  658. data/lib/api_reference.rb +752 -0
  659. metadata +742 -0
@@ -0,0 +1,86 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # SubscriptionMinified Model.
8
+ class SubscriptionMinified < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [String]
14
+ attr_accessor :id
15
+
16
+ # A mapping from model property names to API property names.
17
+ def self.names
18
+ @_hash = {} if @_hash.nil?
19
+ @_hash['id'] = 'id'
20
+ @_hash
21
+ end
22
+
23
+ # An array for optional fields
24
+ def self.optionals
25
+ []
26
+ end
27
+
28
+ # An array for nullable fields
29
+ def self.nullables
30
+ []
31
+ end
32
+
33
+ def initialize(id:, additional_properties: nil)
34
+ # Add additional model properties to the instance
35
+ additional_properties = {} if additional_properties.nil?
36
+
37
+ @id = id
38
+ @additional_properties = additional_properties
39
+ end
40
+
41
+ # Creates an instance of the object from a hash.
42
+ def self.from_hash(hash)
43
+ return nil unless hash
44
+
45
+ # Extract variables from the hash.
46
+ id = hash.key?('id') ? hash['id'] : nil
47
+
48
+ # Create a new hash for additional properties, removing known properties.
49
+ new_hash = hash.reject { |k, _| names.value?(k) }
50
+
51
+ additional_properties = APIHelper.get_additional_properties(
52
+ new_hash, proc { |value| value }
53
+ )
54
+
55
+ # Create object from extracted values.
56
+ SubscriptionMinified.new(id: id,
57
+ additional_properties: additional_properties)
58
+ end
59
+
60
+ # Validates an instance of the object from a given value.
61
+ # @param [SubscriptionMinified | Hash] The value against the validation is performed.
62
+ def self.validate(value)
63
+ if value.instance_of? self
64
+ return APIHelper.valid_type?(value.id,
65
+ ->(val) { val.instance_of? String })
66
+ end
67
+
68
+ return false unless value.instance_of? Hash
69
+
70
+ APIHelper.valid_type?(value['id'],
71
+ ->(val) { val.instance_of? String })
72
+ end
73
+
74
+ # Provides a human-readable string representation of the object.
75
+ def to_s
76
+ class_name = self.class.name.split('::').last
77
+ "<#{class_name} id: #{@id}, additional_properties: #{@additional_properties}>"
78
+ end
79
+
80
+ # Provides a debugging-friendly string with detailed object information.
81
+ def inspect
82
+ class_name = self.class.name.split('::').last
83
+ "<#{class_name} id: #{@id.inspect}, additional_properties: #{@additional_properties}>"
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,502 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ require 'date'
7
+ module ApiReference
8
+ # SubscriptionPlanChange Model.
9
+ class SubscriptionPlanChange < BaseModel
10
+ SKIP = Object.new
11
+ private_constant :SKIP
12
+
13
+ # A list of customer IDs whose usage events will be aggregated and billed
14
+ # under this subscription. By default, a subscription only considers usage
15
+ # events associated with its attached customer's customer_id. When
16
+ # usage_customer_ids is provided, the subscription includes usage events
17
+ # from the specified customers only. Provided usage_customer_ids must be
18
+ # either the customer for this subscription itself, or any of that
19
+ # customer's children.
20
+ # @return [Array[String]]
21
+ attr_accessor :usage_customer_ids
22
+
23
+ # An additional filter to apply to usage queries. This filter must be
24
+ # expressed as a boolean [computed
25
+ # property](/extensibility/advanced-metrics#computed-properties). If null,
26
+ # usage queries will not include any additional filter.
27
+ # @return [String]
28
+ attr_accessor :filter
29
+
30
+ # The plan that the given subscription should be switched to. Note that
31
+ # either this property or `external_plan_id` must be specified.
32
+ # @return [String]
33
+ attr_accessor :plan_id
34
+
35
+ # The external_plan_id of the plan that the given subscription should be
36
+ # switched to. Note that either this property or `plan_id` must be
37
+ # specified.
38
+ # @return [String]
39
+ attr_accessor :external_plan_id
40
+
41
+ # Optionally provide a list of overrides for prices on the plan
42
+ # @return [Array[Object]]
43
+ attr_accessor :price_overrides
44
+
45
+ # Optionally provide a list of overrides for prices on the plan
46
+ # @return [Float]
47
+ attr_accessor :per_credit_overage_amount
48
+
49
+ # Optionally provide a list of overrides for prices on the plan
50
+ # @return [Float]
51
+ attr_accessor :credits_overage_rate
52
+
53
+ # The duration of the trial period in days. If not provided, this defaults
54
+ # to the value specified in the plan. If `0` is provided, the trial on the
55
+ # plan will be skipped.
56
+ # @return [Integer]
57
+ attr_accessor :trial_duration_days
58
+
59
+ # The net terms determines the difference between the invoice date and the
60
+ # issue date for the invoice. If you intend the invoice to be due on issue,
61
+ # set this to 0. If not provided, this defaults to the value specified in
62
+ # the plan.
63
+ # @return [Integer]
64
+ attr_accessor :net_terms
65
+
66
+ # Determines whether issued invoices for this subscription will
67
+ # automatically be charged with the saved payment method on the due date. If
68
+ # not specified, this defaults to the behavior configured for this customer.
69
+ # @return [TrueClass | FalseClass]
70
+ attr_accessor :auto_collection
71
+
72
+ # Used to determine if invoices for this subscription will be automatically
73
+ # issued. If true, invoices will be automatically issued. If false, invoices
74
+ # will require manual approval. If `null` is specified, this defaults to the
75
+ # behavior configured for this customer.
76
+ # @return [TrueClass | FalseClass]
77
+ attr_accessor :auto_issuance
78
+
79
+ # Determines the default memo on this subscription's invoices. Note that if
80
+ # this is not provided, it is determined by the plan configuration.
81
+ # @return [String]
82
+ attr_accessor :default_invoice_memo
83
+
84
+ # Redemption code to be used for this subscription. If the coupon cannot be
85
+ # found by its redemption code, or cannot be redeemed, an error response
86
+ # will be returned and the subscription creation or plan change will not be
87
+ # scheduled.
88
+ # @return [String]
89
+ attr_accessor :coupon_redemption_code
90
+
91
+ # When this subscription's accrued usage reaches this threshold, an invoice
92
+ # will be issued for the subscription. If not specified, invoices will only
93
+ # be issued at the end of the billing period.
94
+ # @return [String]
95
+ attr_accessor :invoicing_threshold
96
+
97
+ # The phase of the plan to start with
98
+ # @return [Integer]
99
+ attr_accessor :initial_phase_order
100
+
101
+ # Additional prices to be added to the subscription. (Only available for
102
+ # accounts that have migrated off of legacy subscription overrides)
103
+ # @return [Array[AddSubscriptionPriceParams]]
104
+ attr_accessor :add_prices
105
+
106
+ # Plan prices to be removed from the subscription. (Only available for
107
+ # accounts that have migrated off of legacy subscription overrides)
108
+ # @return [Array[RemoveSubscriptionPriceParams]]
109
+ attr_accessor :remove_prices
110
+
111
+ # Plan prices to be replaced with additional prices on the subscription.
112
+ # (Only available for accounts that have migrated off of legacy subscription
113
+ # overrides)
114
+ # @return [Array[ReplaceSubscriptionPriceParams]]
115
+ attr_accessor :replace_prices
116
+
117
+ # Additional adjustments to be added to the subscription. (Only available
118
+ # for accounts that have migrated off of legacy subscription overrides)
119
+ # @return [Array[AddSubscriptionAdjustmentParams]]
120
+ attr_accessor :add_adjustments
121
+
122
+ # Plan adjustments to be removed from the subscription. (Only available for
123
+ # accounts that have migrated off of legacy subscription overrides)
124
+ # @return [Array[RemoveSubscriptionAdjustmentParams]]
125
+ attr_accessor :remove_adjustments
126
+
127
+ # Plan adjustments to be replaced with additional adjustments on the
128
+ # subscription. (Only available for accounts that have migrated off of
129
+ # legacy subscription overrides)
130
+ # @return [Array[ReplaceSubscriptionAdjustmentParams]]
131
+ attr_accessor :replace_adjustments
132
+
133
+ # Plan adjustments to be replaced with additional adjustments on the
134
+ # subscription. (Only available for accounts that have migrated off of
135
+ # legacy subscription overrides)
136
+ # @return [ChangeOption1]
137
+ attr_accessor :change_option
138
+
139
+ # The date that the plan change should take effect. This parameter can only
140
+ # be passed if the `change_option` is `requested_date`. If a date with no
141
+ # time is passed, the plan change will happen at midnight in the customer's
142
+ # timezone.
143
+ # @return [DateTime]
144
+ attr_accessor :change_date
145
+
146
+ # [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to
147
+ # be aligned with the plan change's effective date.
148
+ # @return [TrueClass | FalseClass]
149
+ attr_accessor :align_billing_with_plan_change_date
150
+
151
+ # Reset billing periods to be aligned with the plan change's effective date
152
+ # or start of the month. Defaults to `unchanged` which keeps subscription's
153
+ # existing billing cycle alignment.
154
+ # @return [BillingCycleAlignment]
155
+ attr_accessor :billing_cycle_alignment
156
+
157
+ # Specifies which version of the plan to change to. If null, the default
158
+ # version will be used.
159
+ # @return [Integer]
160
+ attr_accessor :plan_version_number
161
+
162
+ # Specifies which version of the plan to change to. If null, the default
163
+ # version will be used.
164
+ # @return [BillingCycleAnchorConfiguration]
165
+ attr_accessor :billing_cycle_anchor_configuration
166
+
167
+ # A mapping from model property names to API property names.
168
+ def self.names
169
+ @_hash = {} if @_hash.nil?
170
+ @_hash['usage_customer_ids'] = 'usage_customer_ids'
171
+ @_hash['filter'] = 'filter'
172
+ @_hash['plan_id'] = 'plan_id'
173
+ @_hash['external_plan_id'] = 'external_plan_id'
174
+ @_hash['price_overrides'] = 'price_overrides'
175
+ @_hash['per_credit_overage_amount'] = 'per_credit_overage_amount'
176
+ @_hash['credits_overage_rate'] = 'credits_overage_rate'
177
+ @_hash['trial_duration_days'] = 'trial_duration_days'
178
+ @_hash['net_terms'] = 'net_terms'
179
+ @_hash['auto_collection'] = 'auto_collection'
180
+ @_hash['auto_issuance'] = 'auto_issuance'
181
+ @_hash['default_invoice_memo'] = 'default_invoice_memo'
182
+ @_hash['coupon_redemption_code'] = 'coupon_redemption_code'
183
+ @_hash['invoicing_threshold'] = 'invoicing_threshold'
184
+ @_hash['initial_phase_order'] = 'initial_phase_order'
185
+ @_hash['add_prices'] = 'add_prices'
186
+ @_hash['remove_prices'] = 'remove_prices'
187
+ @_hash['replace_prices'] = 'replace_prices'
188
+ @_hash['add_adjustments'] = 'add_adjustments'
189
+ @_hash['remove_adjustments'] = 'remove_adjustments'
190
+ @_hash['replace_adjustments'] = 'replace_adjustments'
191
+ @_hash['change_option'] = 'change_option'
192
+ @_hash['change_date'] = 'change_date'
193
+ @_hash['align_billing_with_plan_change_date'] =
194
+ 'align_billing_with_plan_change_date'
195
+ @_hash['billing_cycle_alignment'] = 'billing_cycle_alignment'
196
+ @_hash['plan_version_number'] = 'plan_version_number'
197
+ @_hash['billing_cycle_anchor_configuration'] =
198
+ 'billing_cycle_anchor_configuration'
199
+ @_hash
200
+ end
201
+
202
+ # An array for optional fields
203
+ def self.optionals
204
+ %w[
205
+ usage_customer_ids
206
+ filter
207
+ plan_id
208
+ external_plan_id
209
+ price_overrides
210
+ per_credit_overage_amount
211
+ credits_overage_rate
212
+ trial_duration_days
213
+ net_terms
214
+ auto_collection
215
+ auto_issuance
216
+ default_invoice_memo
217
+ coupon_redemption_code
218
+ invoicing_threshold
219
+ initial_phase_order
220
+ add_prices
221
+ remove_prices
222
+ replace_prices
223
+ add_adjustments
224
+ remove_adjustments
225
+ replace_adjustments
226
+ change_date
227
+ align_billing_with_plan_change_date
228
+ billing_cycle_alignment
229
+ plan_version_number
230
+ billing_cycle_anchor_configuration
231
+ ]
232
+ end
233
+
234
+ # An array for nullable fields
235
+ def self.nullables
236
+ %w[
237
+ usage_customer_ids
238
+ filter
239
+ plan_id
240
+ external_plan_id
241
+ price_overrides
242
+ per_credit_overage_amount
243
+ credits_overage_rate
244
+ trial_duration_days
245
+ net_terms
246
+ auto_collection
247
+ auto_issuance
248
+ default_invoice_memo
249
+ coupon_redemption_code
250
+ invoicing_threshold
251
+ initial_phase_order
252
+ add_prices
253
+ remove_prices
254
+ replace_prices
255
+ add_adjustments
256
+ remove_adjustments
257
+ replace_adjustments
258
+ change_date
259
+ align_billing_with_plan_change_date
260
+ billing_cycle_alignment
261
+ plan_version_number
262
+ billing_cycle_anchor_configuration
263
+ ]
264
+ end
265
+
266
+ def initialize(change_option:, usage_customer_ids: SKIP, filter: SKIP,
267
+ plan_id: SKIP, external_plan_id: SKIP, price_overrides: SKIP,
268
+ per_credit_overage_amount: SKIP, credits_overage_rate: SKIP,
269
+ trial_duration_days: SKIP, net_terms: SKIP,
270
+ auto_collection: SKIP, auto_issuance: SKIP,
271
+ default_invoice_memo: SKIP, coupon_redemption_code: SKIP,
272
+ invoicing_threshold: SKIP, initial_phase_order: SKIP,
273
+ add_prices: SKIP, remove_prices: SKIP, replace_prices: SKIP,
274
+ add_adjustments: SKIP, remove_adjustments: SKIP,
275
+ replace_adjustments: SKIP, change_date: SKIP,
276
+ align_billing_with_plan_change_date: SKIP,
277
+ billing_cycle_alignment: BillingCycleAlignment::UNCHANGED,
278
+ plan_version_number: SKIP,
279
+ billing_cycle_anchor_configuration: SKIP)
280
+ @usage_customer_ids = usage_customer_ids unless usage_customer_ids == SKIP
281
+ @filter = filter unless filter == SKIP
282
+ @plan_id = plan_id unless plan_id == SKIP
283
+ @external_plan_id = external_plan_id unless external_plan_id == SKIP
284
+ @price_overrides = price_overrides unless price_overrides == SKIP
285
+ unless per_credit_overage_amount == SKIP
286
+ @per_credit_overage_amount =
287
+ per_credit_overage_amount
288
+ end
289
+ @credits_overage_rate = credits_overage_rate unless credits_overage_rate == SKIP
290
+ @trial_duration_days = trial_duration_days unless trial_duration_days == SKIP
291
+ @net_terms = net_terms unless net_terms == SKIP
292
+ @auto_collection = auto_collection unless auto_collection == SKIP
293
+ @auto_issuance = auto_issuance unless auto_issuance == SKIP
294
+ @default_invoice_memo = default_invoice_memo unless default_invoice_memo == SKIP
295
+ @coupon_redemption_code = coupon_redemption_code unless coupon_redemption_code == SKIP
296
+ @invoicing_threshold = invoicing_threshold unless invoicing_threshold == SKIP
297
+ @initial_phase_order = initial_phase_order unless initial_phase_order == SKIP
298
+ @add_prices = add_prices unless add_prices == SKIP
299
+ @remove_prices = remove_prices unless remove_prices == SKIP
300
+ @replace_prices = replace_prices unless replace_prices == SKIP
301
+ @add_adjustments = add_adjustments unless add_adjustments == SKIP
302
+ @remove_adjustments = remove_adjustments unless remove_adjustments == SKIP
303
+ @replace_adjustments = replace_adjustments unless replace_adjustments == SKIP
304
+ @change_option = change_option
305
+ @change_date = change_date unless change_date == SKIP
306
+ unless align_billing_with_plan_change_date == SKIP
307
+ @align_billing_with_plan_change_date =
308
+ align_billing_with_plan_change_date
309
+ end
310
+ @billing_cycle_alignment = billing_cycle_alignment unless billing_cycle_alignment == SKIP
311
+ @plan_version_number = plan_version_number unless plan_version_number == SKIP
312
+ unless billing_cycle_anchor_configuration == SKIP
313
+ @billing_cycle_anchor_configuration =
314
+ billing_cycle_anchor_configuration
315
+ end
316
+ end
317
+
318
+ # Creates an instance of the object from a hash.
319
+ def self.from_hash(hash)
320
+ return nil unless hash
321
+
322
+ # Extract variables from the hash.
323
+ change_option = hash.key?('change_option') ? hash['change_option'] : nil
324
+ usage_customer_ids =
325
+ hash.key?('usage_customer_ids') ? hash['usage_customer_ids'] : SKIP
326
+ filter = hash.key?('filter') ? hash['filter'] : SKIP
327
+ plan_id = hash.key?('plan_id') ? hash['plan_id'] : SKIP
328
+ external_plan_id =
329
+ hash.key?('external_plan_id') ? hash['external_plan_id'] : SKIP
330
+ price_overrides =
331
+ hash.key?('price_overrides') ? hash['price_overrides'] : SKIP
332
+ per_credit_overage_amount =
333
+ hash.key?('per_credit_overage_amount') ? hash['per_credit_overage_amount'] : SKIP
334
+ credits_overage_rate =
335
+ hash.key?('credits_overage_rate') ? hash['credits_overage_rate'] : SKIP
336
+ trial_duration_days =
337
+ hash.key?('trial_duration_days') ? hash['trial_duration_days'] : SKIP
338
+ net_terms = hash.key?('net_terms') ? hash['net_terms'] : SKIP
339
+ auto_collection =
340
+ hash.key?('auto_collection') ? hash['auto_collection'] : SKIP
341
+ auto_issuance = hash.key?('auto_issuance') ? hash['auto_issuance'] : SKIP
342
+ default_invoice_memo =
343
+ hash.key?('default_invoice_memo') ? hash['default_invoice_memo'] : SKIP
344
+ coupon_redemption_code =
345
+ hash.key?('coupon_redemption_code') ? hash['coupon_redemption_code'] : SKIP
346
+ invoicing_threshold =
347
+ hash.key?('invoicing_threshold') ? hash['invoicing_threshold'] : SKIP
348
+ initial_phase_order =
349
+ hash.key?('initial_phase_order') ? hash['initial_phase_order'] : SKIP
350
+ # Parameter is an array, so we need to iterate through it
351
+ add_prices = nil
352
+ unless hash['add_prices'].nil?
353
+ add_prices = []
354
+ hash['add_prices'].each do |structure|
355
+ add_prices << (AddSubscriptionPriceParams.from_hash(structure) if structure)
356
+ end
357
+ end
358
+
359
+ add_prices = SKIP unless hash.key?('add_prices')
360
+ # Parameter is an array, so we need to iterate through it
361
+ remove_prices = nil
362
+ unless hash['remove_prices'].nil?
363
+ remove_prices = []
364
+ hash['remove_prices'].each do |structure|
365
+ remove_prices << (RemoveSubscriptionPriceParams.from_hash(structure) if structure)
366
+ end
367
+ end
368
+
369
+ remove_prices = SKIP unless hash.key?('remove_prices')
370
+ # Parameter is an array, so we need to iterate through it
371
+ replace_prices = nil
372
+ unless hash['replace_prices'].nil?
373
+ replace_prices = []
374
+ hash['replace_prices'].each do |structure|
375
+ replace_prices << (ReplaceSubscriptionPriceParams.from_hash(structure) if structure)
376
+ end
377
+ end
378
+
379
+ replace_prices = SKIP unless hash.key?('replace_prices')
380
+ # Parameter is an array, so we need to iterate through it
381
+ add_adjustments = nil
382
+ unless hash['add_adjustments'].nil?
383
+ add_adjustments = []
384
+ hash['add_adjustments'].each do |structure|
385
+ add_adjustments << (AddSubscriptionAdjustmentParams.from_hash(structure) if structure)
386
+ end
387
+ end
388
+
389
+ add_adjustments = SKIP unless hash.key?('add_adjustments')
390
+ # Parameter is an array, so we need to iterate through it
391
+ remove_adjustments = nil
392
+ unless hash['remove_adjustments'].nil?
393
+ remove_adjustments = []
394
+ hash['remove_adjustments'].each do |structure|
395
+ remove_adjustments << (RemoveSubscriptionAdjustmentParams.from_hash(structure) if structure)
396
+ end
397
+ end
398
+
399
+ remove_adjustments = SKIP unless hash.key?('remove_adjustments')
400
+ # Parameter is an array, so we need to iterate through it
401
+ replace_adjustments = nil
402
+ unless hash['replace_adjustments'].nil?
403
+ replace_adjustments = []
404
+ hash['replace_adjustments'].each do |structure|
405
+ replace_adjustments << (ReplaceSubscriptionAdjustmentParams.from_hash(structure) if structure)
406
+ end
407
+ end
408
+
409
+ replace_adjustments = SKIP unless hash.key?('replace_adjustments')
410
+ change_date = if hash.key?('change_date')
411
+ (DateTimeHelper.from_rfc3339(hash['change_date']) if hash['change_date'])
412
+ else
413
+ SKIP
414
+ end
415
+ align_billing_with_plan_change_date =
416
+ hash.key?('align_billing_with_plan_change_date') ? hash['align_billing_with_plan_change_date'] : SKIP
417
+ billing_cycle_alignment =
418
+ hash['billing_cycle_alignment'] ||= BillingCycleAlignment::UNCHANGED
419
+ plan_version_number =
420
+ hash.key?('plan_version_number') ? hash['plan_version_number'] : SKIP
421
+ if hash['billing_cycle_anchor_configuration']
422
+ billing_cycle_anchor_configuration = BillingCycleAnchorConfiguration.from_hash(hash['billing_cycle_anchor_configuration'])
423
+ end
424
+
425
+ # Create object from extracted values.
426
+ SubscriptionPlanChange.new(change_option: change_option,
427
+ usage_customer_ids: usage_customer_ids,
428
+ filter: filter,
429
+ plan_id: plan_id,
430
+ external_plan_id: external_plan_id,
431
+ price_overrides: price_overrides,
432
+ per_credit_overage_amount: per_credit_overage_amount,
433
+ credits_overage_rate: credits_overage_rate,
434
+ trial_duration_days: trial_duration_days,
435
+ net_terms: net_terms,
436
+ auto_collection: auto_collection,
437
+ auto_issuance: auto_issuance,
438
+ default_invoice_memo: default_invoice_memo,
439
+ coupon_redemption_code: coupon_redemption_code,
440
+ invoicing_threshold: invoicing_threshold,
441
+ initial_phase_order: initial_phase_order,
442
+ add_prices: add_prices,
443
+ remove_prices: remove_prices,
444
+ replace_prices: replace_prices,
445
+ add_adjustments: add_adjustments,
446
+ remove_adjustments: remove_adjustments,
447
+ replace_adjustments: replace_adjustments,
448
+ change_date: change_date,
449
+ align_billing_with_plan_change_date: align_billing_with_plan_change_date,
450
+ billing_cycle_alignment: billing_cycle_alignment,
451
+ plan_version_number: plan_version_number,
452
+ billing_cycle_anchor_configuration: billing_cycle_anchor_configuration)
453
+ end
454
+
455
+ def to_custom_change_date
456
+ DateTimeHelper.to_rfc3339(change_date)
457
+ end
458
+
459
+ # Provides a human-readable string representation of the object.
460
+ def to_s
461
+ class_name = self.class.name.split('::').last
462
+ "<#{class_name} usage_customer_ids: #{@usage_customer_ids}, filter: #{@filter}, plan_id:"\
463
+ " #{@plan_id}, external_plan_id: #{@external_plan_id}, price_overrides: #{@price_overrides},"\
464
+ " per_credit_overage_amount: #{@per_credit_overage_amount}, credits_overage_rate:"\
465
+ " #{@credits_overage_rate}, trial_duration_days: #{@trial_duration_days}, net_terms:"\
466
+ " #{@net_terms}, auto_collection: #{@auto_collection}, auto_issuance: #{@auto_issuance},"\
467
+ " default_invoice_memo: #{@default_invoice_memo}, coupon_redemption_code:"\
468
+ " #{@coupon_redemption_code}, invoicing_threshold: #{@invoicing_threshold},"\
469
+ " initial_phase_order: #{@initial_phase_order}, add_prices: #{@add_prices}, remove_prices:"\
470
+ " #{@remove_prices}, replace_prices: #{@replace_prices}, add_adjustments:"\
471
+ " #{@add_adjustments}, remove_adjustments: #{@remove_adjustments}, replace_adjustments:"\
472
+ " #{@replace_adjustments}, change_option: #{@change_option}, change_date: #{@change_date},"\
473
+ " align_billing_with_plan_change_date: #{@align_billing_with_plan_change_date},"\
474
+ " billing_cycle_alignment: #{@billing_cycle_alignment}, plan_version_number:"\
475
+ " #{@plan_version_number}, billing_cycle_anchor_configuration:"\
476
+ " #{@billing_cycle_anchor_configuration}>"
477
+ end
478
+
479
+ # Provides a debugging-friendly string with detailed object information.
480
+ def inspect
481
+ class_name = self.class.name.split('::').last
482
+ "<#{class_name} usage_customer_ids: #{@usage_customer_ids.inspect}, filter:"\
483
+ " #{@filter.inspect}, plan_id: #{@plan_id.inspect}, external_plan_id:"\
484
+ " #{@external_plan_id.inspect}, price_overrides: #{@price_overrides.inspect},"\
485
+ " per_credit_overage_amount: #{@per_credit_overage_amount.inspect}, credits_overage_rate:"\
486
+ " #{@credits_overage_rate.inspect}, trial_duration_days: #{@trial_duration_days.inspect},"\
487
+ " net_terms: #{@net_terms.inspect}, auto_collection: #{@auto_collection.inspect},"\
488
+ " auto_issuance: #{@auto_issuance.inspect}, default_invoice_memo:"\
489
+ " #{@default_invoice_memo.inspect}, coupon_redemption_code:"\
490
+ " #{@coupon_redemption_code.inspect}, invoicing_threshold: #{@invoicing_threshold.inspect},"\
491
+ " initial_phase_order: #{@initial_phase_order.inspect}, add_prices: #{@add_prices.inspect},"\
492
+ " remove_prices: #{@remove_prices.inspect}, replace_prices: #{@replace_prices.inspect},"\
493
+ " add_adjustments: #{@add_adjustments.inspect}, remove_adjustments:"\
494
+ " #{@remove_adjustments.inspect}, replace_adjustments: #{@replace_adjustments.inspect},"\
495
+ " change_option: #{@change_option.inspect}, change_date: #{@change_date.inspect},"\
496
+ " align_billing_with_plan_change_date: #{@align_billing_with_plan_change_date.inspect},"\
497
+ " billing_cycle_alignment: #{@billing_cycle_alignment.inspect}, plan_version_number:"\
498
+ " #{@plan_version_number.inspect}, billing_cycle_anchor_configuration:"\
499
+ " #{@billing_cycle_anchor_configuration.inspect}>"
500
+ end
501
+ end
502
+ end