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,330 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # NewLicenseAllocationUnitPrice Model.
8
+ class NewLicenseAllocationUnitPrice < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # The pricing model type
13
+ # @return [String]
14
+ attr_reader :model_type
15
+
16
+ # Configuration for unit pricing
17
+ # @return [UnitConfig]
18
+ attr_accessor :unit_config
19
+
20
+ # User-specified key/value pairs for the resource. Individual keys can be
21
+ # removed by setting the value to `null`, and the entire metadata mapping
22
+ # can be cleared by setting `metadata` to `null`.
23
+ # @return [Hash[String, String]]
24
+ attr_accessor :metadata
25
+
26
+ # An alias for the price.
27
+ # @return [String]
28
+ attr_accessor :external_price_id
29
+
30
+ # The name of the price.
31
+ # @return [String]
32
+ attr_accessor :name
33
+
34
+ # For dimensional price: specifies a price group and dimension values
35
+ # @return [NewDimensionalPriceConfiguration]
36
+ attr_accessor :dimensional_price_configuration
37
+
38
+ # The ID of the license type to associate with this price.
39
+ # @return [String]
40
+ attr_accessor :license_type_id
41
+
42
+ # The id of the billable metric for the price. Only needed if the price is
43
+ # usage-based.
44
+ # @return [String]
45
+ attr_accessor :billable_metric_id
46
+
47
+ # The id of the item the price will be associated with.
48
+ # @return [String]
49
+ attr_accessor :item_id
50
+
51
+ # If the Price represents a fixed cost, the price will be billed in-advance
52
+ # if this is true, and in-arrears if this is false.
53
+ # @return [TrueClass | FalseClass]
54
+ attr_accessor :billed_in_advance
55
+
56
+ # If the Price represents a fixed cost, this represents the quantity of
57
+ # units applied.
58
+ # @return [Float]
59
+ attr_accessor :fixed_price_quantity
60
+
61
+ # The property used to group this price on an invoice
62
+ # @return [String]
63
+ attr_accessor :invoice_grouping_key
64
+
65
+ # The cadence to bill for this price on.
66
+ # @return [Cadence]
67
+ attr_accessor :cadence
68
+
69
+ # For custom cadence: specifies the duration of the billing period in days
70
+ # or months.
71
+ # @return [NewBillingCycleConfiguration]
72
+ attr_accessor :billing_cycle_configuration
73
+
74
+ # Within each billing cycle, specifies the cadence at which invoices are
75
+ # produced. If unspecified, a single invoice is produced per billing cycle.
76
+ # @return [NewBillingCycleConfiguration]
77
+ attr_accessor :invoicing_cycle_configuration
78
+
79
+ # The per unit conversion rate of the price currency to the invoicing
80
+ # currency.
81
+ # @return [Float]
82
+ attr_accessor :conversion_rate
83
+
84
+ # The configuration for the rate of the price currency to the invoicing
85
+ # currency.
86
+ # @return [Object]
87
+ attr_accessor :conversion_rate_config
88
+
89
+ # An ISO 4217 currency string, or custom pricing unit identifier, in which
90
+ # this price is billed.
91
+ # @return [String]
92
+ attr_accessor :currency
93
+
94
+ # A transient ID that can be used to reference this price when adding
95
+ # adjustments in the same API call.
96
+ # @return [String]
97
+ attr_accessor :reference_id
98
+
99
+ # License allocations to associate with this price. Each entry defines a
100
+ # per-license credit pool granted each cadence. Requires license_type_id or
101
+ # license_type_configuration to be set.
102
+ # @return [Array[NewLicenseAllocation]]
103
+ attr_accessor :license_allocations
104
+
105
+ # A mapping from model property names to API property names.
106
+ def self.names
107
+ @_hash = {} if @_hash.nil?
108
+ @_hash['model_type'] = 'model_type'
109
+ @_hash['unit_config'] = 'unit_config'
110
+ @_hash['metadata'] = 'metadata'
111
+ @_hash['external_price_id'] = 'external_price_id'
112
+ @_hash['name'] = 'name'
113
+ @_hash['dimensional_price_configuration'] =
114
+ 'dimensional_price_configuration'
115
+ @_hash['license_type_id'] = 'license_type_id'
116
+ @_hash['billable_metric_id'] = 'billable_metric_id'
117
+ @_hash['item_id'] = 'item_id'
118
+ @_hash['billed_in_advance'] = 'billed_in_advance'
119
+ @_hash['fixed_price_quantity'] = 'fixed_price_quantity'
120
+ @_hash['invoice_grouping_key'] = 'invoice_grouping_key'
121
+ @_hash['cadence'] = 'cadence'
122
+ @_hash['billing_cycle_configuration'] = 'billing_cycle_configuration'
123
+ @_hash['invoicing_cycle_configuration'] =
124
+ 'invoicing_cycle_configuration'
125
+ @_hash['conversion_rate'] = 'conversion_rate'
126
+ @_hash['conversion_rate_config'] = 'conversion_rate_config'
127
+ @_hash['currency'] = 'currency'
128
+ @_hash['reference_id'] = 'reference_id'
129
+ @_hash['license_allocations'] = 'license_allocations'
130
+ @_hash
131
+ end
132
+
133
+ # An array for optional fields
134
+ def self.optionals
135
+ %w[
136
+ metadata
137
+ external_price_id
138
+ dimensional_price_configuration
139
+ license_type_id
140
+ billable_metric_id
141
+ billed_in_advance
142
+ fixed_price_quantity
143
+ invoice_grouping_key
144
+ billing_cycle_configuration
145
+ invoicing_cycle_configuration
146
+ conversion_rate
147
+ conversion_rate_config
148
+ currency
149
+ reference_id
150
+ ]
151
+ end
152
+
153
+ # An array for nullable fields
154
+ def self.nullables
155
+ %w[
156
+ metadata
157
+ external_price_id
158
+ dimensional_price_configuration
159
+ license_type_id
160
+ billable_metric_id
161
+ billed_in_advance
162
+ fixed_price_quantity
163
+ invoice_grouping_key
164
+ billing_cycle_configuration
165
+ invoicing_cycle_configuration
166
+ conversion_rate
167
+ conversion_rate_config
168
+ currency
169
+ reference_id
170
+ ]
171
+ end
172
+
173
+ def initialize(unit_config:, name:, item_id:, cadence:,
174
+ license_allocations:, metadata: SKIP,
175
+ external_price_id: SKIP,
176
+ dimensional_price_configuration: SKIP, license_type_id: SKIP,
177
+ billable_metric_id: SKIP, billed_in_advance: SKIP,
178
+ fixed_price_quantity: SKIP, invoice_grouping_key: SKIP,
179
+ billing_cycle_configuration: SKIP,
180
+ invoicing_cycle_configuration: SKIP, conversion_rate: SKIP,
181
+ conversion_rate_config: SKIP, currency: SKIP,
182
+ reference_id: SKIP, additional_properties: nil)
183
+ # Add additional model properties to the instance
184
+ additional_properties = {} if additional_properties.nil?
185
+
186
+ @model_type = 'unit'
187
+ @unit_config = unit_config
188
+ @metadata = metadata unless metadata == SKIP
189
+ @external_price_id = external_price_id unless external_price_id == SKIP
190
+ @name = name
191
+ unless dimensional_price_configuration == SKIP
192
+ @dimensional_price_configuration =
193
+ dimensional_price_configuration
194
+ end
195
+ @license_type_id = license_type_id unless license_type_id == SKIP
196
+ @billable_metric_id = billable_metric_id unless billable_metric_id == SKIP
197
+ @item_id = item_id
198
+ @billed_in_advance = billed_in_advance unless billed_in_advance == SKIP
199
+ @fixed_price_quantity = fixed_price_quantity unless fixed_price_quantity == SKIP
200
+ @invoice_grouping_key = invoice_grouping_key unless invoice_grouping_key == SKIP
201
+ @cadence = cadence
202
+ unless billing_cycle_configuration == SKIP
203
+ @billing_cycle_configuration =
204
+ billing_cycle_configuration
205
+ end
206
+ unless invoicing_cycle_configuration == SKIP
207
+ @invoicing_cycle_configuration =
208
+ invoicing_cycle_configuration
209
+ end
210
+ @conversion_rate = conversion_rate unless conversion_rate == SKIP
211
+ @conversion_rate_config = conversion_rate_config unless conversion_rate_config == SKIP
212
+ @currency = currency unless currency == SKIP
213
+ @reference_id = reference_id unless reference_id == SKIP
214
+ @license_allocations = license_allocations
215
+ @additional_properties = additional_properties
216
+ end
217
+
218
+ # Creates an instance of the object from a hash.
219
+ def self.from_hash(hash)
220
+ return nil unless hash
221
+
222
+ # Extract variables from the hash.
223
+ unit_config = UnitConfig.from_hash(hash['unit_config']) if hash['unit_config']
224
+ name = hash.key?('name') ? hash['name'] : nil
225
+ item_id = hash.key?('item_id') ? hash['item_id'] : nil
226
+ cadence = hash.key?('cadence') ? hash['cadence'] : nil
227
+ # Parameter is an array, so we need to iterate through it
228
+ license_allocations = nil
229
+ unless hash['license_allocations'].nil?
230
+ license_allocations = []
231
+ hash['license_allocations'].each do |structure|
232
+ license_allocations << (NewLicenseAllocation.from_hash(structure) if structure)
233
+ end
234
+ end
235
+
236
+ license_allocations = nil unless hash.key?('license_allocations')
237
+ metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
238
+ external_price_id =
239
+ hash.key?('external_price_id') ? hash['external_price_id'] : SKIP
240
+ if hash['dimensional_price_configuration']
241
+ dimensional_price_configuration = NewDimensionalPriceConfiguration.from_hash(hash['dimensional_price_configuration'])
242
+ end
243
+ license_type_id =
244
+ hash.key?('license_type_id') ? hash['license_type_id'] : SKIP
245
+ billable_metric_id =
246
+ hash.key?('billable_metric_id') ? hash['billable_metric_id'] : SKIP
247
+ billed_in_advance =
248
+ hash.key?('billed_in_advance') ? hash['billed_in_advance'] : SKIP
249
+ fixed_price_quantity =
250
+ hash.key?('fixed_price_quantity') ? hash['fixed_price_quantity'] : SKIP
251
+ invoice_grouping_key =
252
+ hash.key?('invoice_grouping_key') ? hash['invoice_grouping_key'] : SKIP
253
+ if hash['billing_cycle_configuration']
254
+ billing_cycle_configuration = NewBillingCycleConfiguration.from_hash(hash['billing_cycle_configuration'])
255
+ end
256
+ if hash['invoicing_cycle_configuration']
257
+ invoicing_cycle_configuration = NewBillingCycleConfiguration.from_hash(hash['invoicing_cycle_configuration'])
258
+ end
259
+ conversion_rate =
260
+ hash.key?('conversion_rate') ? hash['conversion_rate'] : SKIP
261
+ conversion_rate_config =
262
+ hash.key?('conversion_rate_config') ? hash['conversion_rate_config'] : SKIP
263
+ currency = hash.key?('currency') ? hash['currency'] : SKIP
264
+ reference_id = hash.key?('reference_id') ? hash['reference_id'] : SKIP
265
+
266
+ # Create a new hash for additional properties, removing known properties.
267
+ new_hash = hash.reject { |k, _| names.value?(k) }
268
+
269
+ additional_properties = APIHelper.get_additional_properties(
270
+ new_hash, proc { |value| value }
271
+ )
272
+
273
+ # Create object from extracted values.
274
+ NewLicenseAllocationUnitPrice.new(unit_config: unit_config,
275
+ name: name,
276
+ item_id: item_id,
277
+ cadence: cadence,
278
+ license_allocations: license_allocations,
279
+ metadata: metadata,
280
+ external_price_id: external_price_id,
281
+ dimensional_price_configuration: dimensional_price_configuration,
282
+ license_type_id: license_type_id,
283
+ billable_metric_id: billable_metric_id,
284
+ billed_in_advance: billed_in_advance,
285
+ fixed_price_quantity: fixed_price_quantity,
286
+ invoice_grouping_key: invoice_grouping_key,
287
+ billing_cycle_configuration: billing_cycle_configuration,
288
+ invoicing_cycle_configuration: invoicing_cycle_configuration,
289
+ conversion_rate: conversion_rate,
290
+ conversion_rate_config: conversion_rate_config,
291
+ currency: currency,
292
+ reference_id: reference_id,
293
+ additional_properties: additional_properties)
294
+ end
295
+
296
+ # Provides a human-readable string representation of the object.
297
+ def to_s
298
+ class_name = self.class.name.split('::').last
299
+ "<#{class_name} model_type: #{@model_type}, unit_config: #{@unit_config}, metadata:"\
300
+ " #{@metadata}, external_price_id: #{@external_price_id}, name: #{@name},"\
301
+ " dimensional_price_configuration: #{@dimensional_price_configuration}, license_type_id:"\
302
+ " #{@license_type_id}, billable_metric_id: #{@billable_metric_id}, item_id: #{@item_id},"\
303
+ " billed_in_advance: #{@billed_in_advance}, fixed_price_quantity: #{@fixed_price_quantity},"\
304
+ " invoice_grouping_key: #{@invoice_grouping_key}, cadence: #{@cadence},"\
305
+ " billing_cycle_configuration: #{@billing_cycle_configuration},"\
306
+ " invoicing_cycle_configuration: #{@invoicing_cycle_configuration}, conversion_rate:"\
307
+ " #{@conversion_rate}, conversion_rate_config: #{@conversion_rate_config}, currency:"\
308
+ " #{@currency}, reference_id: #{@reference_id}, license_allocations:"\
309
+ " #{@license_allocations}, additional_properties: #{@additional_properties}>"
310
+ end
311
+
312
+ # Provides a debugging-friendly string with detailed object information.
313
+ def inspect
314
+ class_name = self.class.name.split('::').last
315
+ "<#{class_name} model_type: #{@model_type.inspect}, unit_config: #{@unit_config.inspect},"\
316
+ " metadata: #{@metadata.inspect}, external_price_id: #{@external_price_id.inspect}, name:"\
317
+ " #{@name.inspect}, dimensional_price_configuration:"\
318
+ " #{@dimensional_price_configuration.inspect}, license_type_id: #{@license_type_id.inspect},"\
319
+ " billable_metric_id: #{@billable_metric_id.inspect}, item_id: #{@item_id.inspect},"\
320
+ " billed_in_advance: #{@billed_in_advance.inspect}, fixed_price_quantity:"\
321
+ " #{@fixed_price_quantity.inspect}, invoice_grouping_key: #{@invoice_grouping_key.inspect},"\
322
+ " cadence: #{@cadence.inspect}, billing_cycle_configuration:"\
323
+ " #{@billing_cycle_configuration.inspect}, invoicing_cycle_configuration:"\
324
+ " #{@invoicing_cycle_configuration.inspect}, conversion_rate: #{@conversion_rate.inspect},"\
325
+ " conversion_rate_config: #{@conversion_rate_config.inspect}, currency:"\
326
+ " #{@currency.inspect}, reference_id: #{@reference_id.inspect}, license_allocations:"\
327
+ " #{@license_allocations.inspect}, additional_properties: #{@additional_properties}>"
328
+ end
329
+ end
330
+ end
@@ -0,0 +1,69 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # NewLicenseType Model.
8
+ class NewLicenseType < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # The name of the license type.
13
+ # @return [String]
14
+ attr_accessor :name
15
+
16
+ # The key used for grouping licenses of this type. This is typically a user
17
+ # identifier field.
18
+ # @return [String]
19
+ attr_accessor :grouping_key
20
+
21
+ # A mapping from model property names to API property names.
22
+ def self.names
23
+ @_hash = {} if @_hash.nil?
24
+ @_hash['name'] = 'name'
25
+ @_hash['grouping_key'] = 'grouping_key'
26
+ @_hash
27
+ end
28
+
29
+ # An array for optional fields
30
+ def self.optionals
31
+ []
32
+ end
33
+
34
+ # An array for nullable fields
35
+ def self.nullables
36
+ []
37
+ end
38
+
39
+ def initialize(name:, grouping_key:)
40
+ @name = name
41
+ @grouping_key = grouping_key
42
+ end
43
+
44
+ # Creates an instance of the object from a hash.
45
+ def self.from_hash(hash)
46
+ return nil unless hash
47
+
48
+ # Extract variables from the hash.
49
+ name = hash.key?('name') ? hash['name'] : nil
50
+ grouping_key = hash.key?('grouping_key') ? hash['grouping_key'] : nil
51
+
52
+ # Create object from extracted values.
53
+ NewLicenseType.new(name: name,
54
+ grouping_key: grouping_key)
55
+ end
56
+
57
+ # Provides a human-readable string representation of the object.
58
+ def to_s
59
+ class_name = self.class.name.split('::').last
60
+ "<#{class_name} name: #{@name}, grouping_key: #{@grouping_key}>"
61
+ end
62
+
63
+ # Provides a debugging-friendly string with detailed object information.
64
+ def inspect
65
+ class_name = self.class.name.split('::').last
66
+ "<#{class_name} name: #{@name.inspect}, grouping_key: #{@grouping_key.inspect}>"
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,78 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # NewLicenseTypeConfiguration Model.
8
+ class NewLicenseTypeConfiguration < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # The property used to group this price for licensing
13
+ # @return [String]
14
+ attr_accessor :license_grouping_key
15
+
16
+ # The ID of the license type associated with this price.
17
+ # @return [String]
18
+ attr_accessor :license_type_id
19
+
20
+ # A mapping from model property names to API property names.
21
+ def self.names
22
+ @_hash = {} if @_hash.nil?
23
+ @_hash['license_grouping_key'] = 'license_grouping_key'
24
+ @_hash['license_type_id'] = 'license_type_id'
25
+ @_hash
26
+ end
27
+
28
+ # An array for optional fields
29
+ def self.optionals
30
+ %w[
31
+ license_grouping_key
32
+ license_type_id
33
+ ]
34
+ end
35
+
36
+ # An array for nullable fields
37
+ def self.nullables
38
+ %w[
39
+ license_grouping_key
40
+ license_type_id
41
+ ]
42
+ end
43
+
44
+ def initialize(license_grouping_key: SKIP, license_type_id: SKIP)
45
+ @license_grouping_key = license_grouping_key unless license_grouping_key == SKIP
46
+ @license_type_id = license_type_id unless license_type_id == SKIP
47
+ end
48
+
49
+ # Creates an instance of the object from a hash.
50
+ def self.from_hash(hash)
51
+ return nil unless hash
52
+
53
+ # Extract variables from the hash.
54
+ license_grouping_key =
55
+ hash.key?('license_grouping_key') ? hash['license_grouping_key'] : SKIP
56
+ license_type_id =
57
+ hash.key?('license_type_id') ? hash['license_type_id'] : SKIP
58
+
59
+ # Create object from extracted values.
60
+ NewLicenseTypeConfiguration.new(license_grouping_key: license_grouping_key,
61
+ license_type_id: license_type_id)
62
+ end
63
+
64
+ # Provides a human-readable string representation of the object.
65
+ def to_s
66
+ class_name = self.class.name.split('::').last
67
+ "<#{class_name} license_grouping_key: #{@license_grouping_key}, license_type_id:"\
68
+ " #{@license_type_id}>"
69
+ end
70
+
71
+ # Provides a debugging-friendly string with detailed object information.
72
+ def inspect
73
+ class_name = self.class.name.split('::').last
74
+ "<#{class_name} license_grouping_key: #{@license_grouping_key.inspect}, license_type_id:"\
75
+ " #{@license_type_id.inspect}>"
76
+ end
77
+ end
78
+ end
@@ -0,0 +1,202 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # NewMaximum Model.
8
+ class NewMaximum < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # The set of price IDs to which this adjustment applies.
13
+ # @return [Array[String]]
14
+ attr_accessor :applies_to_price_ids
15
+
16
+ # The set of item IDs to which this adjustment applies.
17
+ # @return [Array[String]]
18
+ attr_accessor :applies_to_item_ids
19
+
20
+ # If set, the adjustment will apply to every price on the subscription.
21
+ # @return [TrueClass | FalseClass]
22
+ attr_accessor :applies_to_all
23
+
24
+ # A list of filters that determine which prices this adjustment will apply
25
+ # to.
26
+ # @return [Array[PriceFilter]]
27
+ attr_accessor :filters
28
+
29
+ # If set, only prices in the specified currency will have the adjustment
30
+ # applied.
31
+ # @return [String]
32
+ attr_accessor :currency
33
+
34
+ # If set, only prices of the specified type will have the adjustment
35
+ # applied.
36
+ # @return [PriceType]
37
+ attr_accessor :price_type
38
+
39
+ # When false, this adjustment will be applied to a single price. Otherwise,
40
+ # it will be applied at the invoice level, possibly to multiple prices.
41
+ # @return [TrueClass | FalseClass]
42
+ attr_accessor :is_invoice_level
43
+
44
+ # When false, this adjustment will be applied to a single price. Otherwise,
45
+ # it will be applied at the invoice level, possibly to multiple prices.
46
+ # @return [String]
47
+ attr_reader :adjustment_type
48
+
49
+ # When false, this adjustment will be applied to a single price. Otherwise,
50
+ # it will be applied at the invoice level, possibly to multiple prices.
51
+ # @return [String]
52
+ attr_accessor :maximum_amount
53
+
54
+ # A mapping from model property names to API property names.
55
+ def self.names
56
+ @_hash = {} if @_hash.nil?
57
+ @_hash['applies_to_price_ids'] = 'applies_to_price_ids'
58
+ @_hash['applies_to_item_ids'] = 'applies_to_item_ids'
59
+ @_hash['applies_to_all'] = 'applies_to_all'
60
+ @_hash['filters'] = 'filters'
61
+ @_hash['currency'] = 'currency'
62
+ @_hash['price_type'] = 'price_type'
63
+ @_hash['is_invoice_level'] = 'is_invoice_level'
64
+ @_hash['adjustment_type'] = 'adjustment_type'
65
+ @_hash['maximum_amount'] = 'maximum_amount'
66
+ @_hash
67
+ end
68
+
69
+ # An array for optional fields
70
+ def self.optionals
71
+ %w[
72
+ applies_to_price_ids
73
+ applies_to_item_ids
74
+ applies_to_all
75
+ filters
76
+ currency
77
+ price_type
78
+ is_invoice_level
79
+ ]
80
+ end
81
+
82
+ # An array for nullable fields
83
+ def self.nullables
84
+ %w[
85
+ applies_to_price_ids
86
+ applies_to_item_ids
87
+ applies_to_all
88
+ filters
89
+ currency
90
+ price_type
91
+ ]
92
+ end
93
+
94
+ def initialize(maximum_amount:, applies_to_price_ids: SKIP,
95
+ applies_to_item_ids: SKIP, applies_to_all: SKIP,
96
+ filters: SKIP, currency: SKIP, price_type: SKIP,
97
+ is_invoice_level: true, additional_properties: nil)
98
+ # Add additional model properties to the instance
99
+ additional_properties = {} if additional_properties.nil?
100
+
101
+ @applies_to_price_ids = applies_to_price_ids unless applies_to_price_ids == SKIP
102
+ @applies_to_item_ids = applies_to_item_ids unless applies_to_item_ids == SKIP
103
+ @applies_to_all = applies_to_all unless applies_to_all == SKIP
104
+ @filters = filters unless filters == SKIP
105
+ @currency = currency unless currency == SKIP
106
+ @price_type = price_type unless price_type == SKIP
107
+ @is_invoice_level = is_invoice_level unless is_invoice_level == SKIP
108
+ @adjustment_type = 'maximum'
109
+ @maximum_amount = maximum_amount
110
+ @additional_properties = additional_properties
111
+ end
112
+
113
+ # Creates an instance of the object from a hash.
114
+ def self.from_hash(hash)
115
+ return nil unless hash
116
+
117
+ # Extract variables from the hash.
118
+ maximum_amount =
119
+ hash.key?('maximum_amount') ? hash['maximum_amount'] : nil
120
+ applies_to_price_ids =
121
+ hash.key?('applies_to_price_ids') ? hash['applies_to_price_ids'] : SKIP
122
+ applies_to_item_ids =
123
+ hash.key?('applies_to_item_ids') ? hash['applies_to_item_ids'] : SKIP
124
+ applies_to_all =
125
+ hash.key?('applies_to_all') ? hash['applies_to_all'] : SKIP
126
+ # Parameter is an array, so we need to iterate through it
127
+ filters = nil
128
+ unless hash['filters'].nil?
129
+ filters = []
130
+ hash['filters'].each do |structure|
131
+ filters << (PriceFilter.from_hash(structure) if structure)
132
+ end
133
+ end
134
+
135
+ filters = SKIP unless hash.key?('filters')
136
+ currency = hash.key?('currency') ? hash['currency'] : SKIP
137
+ price_type = hash.key?('price_type') ? hash['price_type'] : SKIP
138
+ is_invoice_level = hash['is_invoice_level'] ||= true
139
+
140
+ # Create a new hash for additional properties, removing known properties.
141
+ new_hash = hash.reject { |k, _| names.value?(k) }
142
+
143
+ additional_properties = APIHelper.get_additional_properties(
144
+ new_hash, proc { |value| value }
145
+ )
146
+
147
+ # Create object from extracted values.
148
+ NewMaximum.new(maximum_amount: maximum_amount,
149
+ applies_to_price_ids: applies_to_price_ids,
150
+ applies_to_item_ids: applies_to_item_ids,
151
+ applies_to_all: applies_to_all,
152
+ filters: filters,
153
+ currency: currency,
154
+ price_type: price_type,
155
+ is_invoice_level: is_invoice_level,
156
+ additional_properties: additional_properties)
157
+ end
158
+
159
+ # Validates an instance of the object from a given value.
160
+ # @param [NewMaximum | Hash] The value against the validation is performed.
161
+ def self.validate(value)
162
+ if value.instance_of? self
163
+ return (
164
+ APIHelper.valid_type?(value.adjustment_type,
165
+ ->(val) { val.instance_of? String }) and
166
+ APIHelper.valid_type?(value.maximum_amount,
167
+ ->(val) { val.instance_of? String })
168
+ )
169
+ end
170
+
171
+ return false unless value.instance_of? Hash
172
+
173
+ (
174
+ APIHelper.valid_type?(value['adjustment_type'],
175
+ ->(val) { val.instance_of? String }) and
176
+ APIHelper.valid_type?(value['maximum_amount'],
177
+ ->(val) { val.instance_of? String })
178
+ )
179
+ end
180
+
181
+ # Provides a human-readable string representation of the object.
182
+ def to_s
183
+ class_name = self.class.name.split('::').last
184
+ "<#{class_name} applies_to_price_ids: #{@applies_to_price_ids}, applies_to_item_ids:"\
185
+ " #{@applies_to_item_ids}, applies_to_all: #{@applies_to_all}, filters: #{@filters},"\
186
+ " currency: #{@currency}, price_type: #{@price_type}, is_invoice_level:"\
187
+ " #{@is_invoice_level}, adjustment_type: #{@adjustment_type}, maximum_amount:"\
188
+ " #{@maximum_amount}, additional_properties: #{@additional_properties}>"
189
+ end
190
+
191
+ # Provides a debugging-friendly string with detailed object information.
192
+ def inspect
193
+ class_name = self.class.name.split('::').last
194
+ "<#{class_name} applies_to_price_ids: #{@applies_to_price_ids.inspect},"\
195
+ " applies_to_item_ids: #{@applies_to_item_ids.inspect}, applies_to_all:"\
196
+ " #{@applies_to_all.inspect}, filters: #{@filters.inspect}, currency: #{@currency.inspect},"\
197
+ " price_type: #{@price_type.inspect}, is_invoice_level: #{@is_invoice_level.inspect},"\
198
+ " adjustment_type: #{@adjustment_type.inspect}, maximum_amount: #{@maximum_amount.inspect},"\
199
+ " additional_properties: #{@additional_properties}>"
200
+ end
201
+ end
202
+ end