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,683 @@
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
+ # MutatedSubscription Model.
9
+ class MutatedSubscription < BaseModel
10
+ SKIP = Object.new
11
+ private_constant :SKIP
12
+
13
+ # User specified key-value pairs for the resource. If not present, this
14
+ # defaults to an empty dictionary. Individual keys can be removed by setting
15
+ # the value to `null`, and the entire metadata mapping can be cleared by
16
+ # setting `metadata` to `null`.
17
+ # @return [Hash[String, String]]
18
+ attr_accessor :metadata
19
+
20
+ # User specified key-value pairs for the resource. If not present, this
21
+ # defaults to an empty dictionary. Individual keys can be removed by setting
22
+ # the value to `null`, and the entire metadata mapping can be cleared by
23
+ # setting `metadata` to `null`.
24
+ # @return [String]
25
+ attr_accessor :id
26
+
27
+ # A customer is a buyer of your products, and the other party to the billing
28
+ # relationship.
29
+ # In Orb, customers are assigned system generated identifiers automatically,
30
+ # but it's often desirable to have these
31
+ # match existing identifiers in your system. To avoid having to denormalize
32
+ # Orb ID information, you can pass in an
33
+ # `external_customer_id` with your own identifier. See
34
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
35
+ # information about how these
36
+ # aliases work in Orb.
37
+ # In addition to having an identifier in your system, a customer may exist
38
+ # in a payment provider solution like
39
+ # Stripe. Use the `payment_provider_id` and the `payment_provider` enum
40
+ # field to express this mapping.
41
+ # A customer also has a timezone (from the standard [IANA timezone
42
+ # database](https://www.iana.org/time-zones)), which
43
+ # defaults to your account's timezone. See [Timezone
44
+ # localization](/essentials/timezones) for
45
+ # information on what this timezone parameter influences within Orb.
46
+ # @return [Customer]
47
+ attr_accessor :customer
48
+
49
+ # A customer is a buyer of your products, and the other party to the billing
50
+ # relationship.
51
+ # In Orb, customers are assigned system generated identifiers automatically,
52
+ # but it's often desirable to have these
53
+ # match existing identifiers in your system. To avoid having to denormalize
54
+ # Orb ID information, you can pass in an
55
+ # `external_customer_id` with your own identifier. See
56
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
57
+ # information about how these
58
+ # aliases work in Orb.
59
+ # In addition to having an identifier in your system, a customer may exist
60
+ # in a payment provider solution like
61
+ # Stripe. Use the `payment_provider_id` and the `payment_provider` enum
62
+ # field to express this mapping.
63
+ # A customer also has a timezone (from the standard [IANA timezone
64
+ # database](https://www.iana.org/time-zones)), which
65
+ # defaults to your account's timezone. See [Timezone
66
+ # localization](/essentials/timezones) for
67
+ # information on what this timezone parameter influences within Orb.
68
+ # @return [Plan]
69
+ attr_accessor :plan
70
+
71
+ # The name of the subscription.
72
+ # @return [String]
73
+ attr_accessor :name
74
+
75
+ # The date Orb starts billing for this subscription.
76
+ # @return [DateTime]
77
+ attr_accessor :start_date
78
+
79
+ # The date Orb stops billing for this subscription.
80
+ # @return [DateTime]
81
+ attr_accessor :end_date
82
+
83
+ # The date Orb stops billing for this subscription.
84
+ # @return [DateTime]
85
+ attr_accessor :created_at
86
+
87
+ # The start date of the current billing period. This is an inclusive
88
+ # timestamp; the instant returned is exactly the beginning of the billing
89
+ # period. Set to null if the subscription is not currently active.
90
+ # @return [DateTime]
91
+ attr_accessor :current_billing_period_start_date
92
+
93
+ # The end of the current billing period. This is an exclusive timestamp,
94
+ # such that the instant returned is not part of the billing period. Set to
95
+ # null for subscriptions that are not currently active.
96
+ # @return [DateTime]
97
+ attr_accessor :current_billing_period_end_date
98
+
99
+ # The end of the current billing period. This is an exclusive timestamp,
100
+ # such that the instant returned is not part of the billing period. Set to
101
+ # null for subscriptions that are not currently active.
102
+ # @return [Status13]
103
+ attr_accessor :status
104
+
105
+ # The end of the current billing period. This is an exclusive timestamp,
106
+ # such that the instant returned is not part of the billing period. Set to
107
+ # null for subscriptions that are not currently active.
108
+ # @return [SubscriptionTrialInfo]
109
+ attr_accessor :trial_info
110
+
111
+ # The current plan phase that is active, only if the subscription's plan has
112
+ # phases.
113
+ # @return [Integer]
114
+ attr_accessor :active_plan_phase_order
115
+
116
+ # The current plan phase that is active, only if the subscription's plan has
117
+ # phases.
118
+ # @return [Array[FixedFeeQuantityScheduleEntry]]
119
+ attr_accessor :fixed_fee_quantity_schedule
120
+
121
+ # Determines the default memo on this subscriptions' invoices. Note that if
122
+ # this is not provided, it is determined by the plan configuration.
123
+ # @return [String]
124
+ attr_accessor :default_invoice_memo
125
+
126
+ # Determines whether issued invoices for this subscription will
127
+ # automatically be charged with the saved payment method on the due date.
128
+ # This property defaults to the plan's behavior. If null, defaults to the
129
+ # customer's setting.
130
+ # @return [TrueClass | FalseClass]
131
+ attr_accessor :auto_collection
132
+
133
+ # Determines whether invoices for this subscription will be automatically
134
+ # issued. This resolves the effective setting for the subscription: a
135
+ # subscription-level override if set, otherwise the customer-level setting,
136
+ # otherwise the account-level default.
137
+ # @return [TrueClass | FalseClass]
138
+ attr_accessor :auto_issuance
139
+
140
+ # Determines the difference between the invoice issue date for subscription
141
+ # invoices as the date that they are due. A value of `0` here represents
142
+ # that the invoice is due on issue, whereas a value of `30` represents that
143
+ # the customer has a month to pay the invoice.
144
+ # @return [Integer]
145
+ attr_accessor :net_terms
146
+
147
+ # Determines the difference between the invoice issue date for subscription
148
+ # invoices as the date that they are due. A value of `0` here represents
149
+ # that the invoice is due on issue, whereas a value of `30` represents that
150
+ # the customer has a month to pay the invoice.
151
+ # @return [CouponRedemption]
152
+ attr_accessor :redeemed_coupon
153
+
154
+ # The day of the month on which the billing cycle is anchored. If the
155
+ # maximum number of days in a month is greater than this value, the last day
156
+ # of the month is the billing cycle day (e.g. billing_cycle_day=31 for April
157
+ # means the billing period begins on the 30th.
158
+ # @return [Integer]
159
+ attr_accessor :billing_cycle_day
160
+
161
+ # The day of the month on which the billing cycle is anchored. If the
162
+ # maximum number of days in a month is greater than this value, the last day
163
+ # of the month is the billing cycle day (e.g. billing_cycle_day=31 for April
164
+ # means the billing period begins on the 30th.
165
+ # @return [BillingCycleAnchorConfiguration]
166
+ attr_accessor :billing_cycle_anchor_configuration
167
+
168
+ # The day of the month on which the billing cycle is anchored. If the
169
+ # maximum number of days in a month is greater than this value, the last day
170
+ # of the month is the billing cycle day (e.g. billing_cycle_day=31 for April
171
+ # means the billing period begins on the 30th.
172
+ # @return [String]
173
+ attr_accessor :invoicing_threshold
174
+
175
+ # The price intervals for this subscription.
176
+ # @return [Array[PriceInterval]]
177
+ attr_accessor :price_intervals
178
+
179
+ # The adjustment intervals for this subscription sorted by the start_date of
180
+ # the adjustment interval.
181
+ # @return [Array[AdjustmentInterval]]
182
+ attr_accessor :adjustment_intervals
183
+
184
+ # The discount intervals for this subscription sorted by the start_date.
185
+ # This field is deprecated in favor of `adjustment_intervals`.
186
+ # @return [Array[Object]]
187
+ attr_accessor :discount_intervals
188
+
189
+ # The minimum intervals for this subscription sorted by the start_date. This
190
+ # field is deprecated in favor of `adjustment_intervals`.
191
+ # @return [Array[MinimumInterval]]
192
+ attr_accessor :minimum_intervals
193
+
194
+ # The maximum intervals for this subscription sorted by the start_date. This
195
+ # field is deprecated in favor of `adjustment_intervals`.
196
+ # @return [Array[MaximumInterval]]
197
+ attr_accessor :maximum_intervals
198
+
199
+ # A pending subscription change if one exists on this subscription.
200
+ # @return [SubscriptionChangeMinified]
201
+ attr_accessor :pending_subscription_change
202
+
203
+ # The resources that were changed as part of this operation. Only present
204
+ # when fetched through the subscription changes API or if the
205
+ # `include_changed_resources` parameter was passed in the request.
206
+ # @return [ChangedSubscriptionResources]
207
+ attr_accessor :changed_resources
208
+
209
+ # A mapping from model property names to API property names.
210
+ def self.names
211
+ @_hash = {} if @_hash.nil?
212
+ @_hash['metadata'] = 'metadata'
213
+ @_hash['id'] = 'id'
214
+ @_hash['customer'] = 'customer'
215
+ @_hash['plan'] = 'plan'
216
+ @_hash['name'] = 'name'
217
+ @_hash['start_date'] = 'start_date'
218
+ @_hash['end_date'] = 'end_date'
219
+ @_hash['created_at'] = 'created_at'
220
+ @_hash['current_billing_period_start_date'] =
221
+ 'current_billing_period_start_date'
222
+ @_hash['current_billing_period_end_date'] =
223
+ 'current_billing_period_end_date'
224
+ @_hash['status'] = 'status'
225
+ @_hash['trial_info'] = 'trial_info'
226
+ @_hash['active_plan_phase_order'] = 'active_plan_phase_order'
227
+ @_hash['fixed_fee_quantity_schedule'] = 'fixed_fee_quantity_schedule'
228
+ @_hash['default_invoice_memo'] = 'default_invoice_memo'
229
+ @_hash['auto_collection'] = 'auto_collection'
230
+ @_hash['auto_issuance'] = 'auto_issuance'
231
+ @_hash['net_terms'] = 'net_terms'
232
+ @_hash['redeemed_coupon'] = 'redeemed_coupon'
233
+ @_hash['billing_cycle_day'] = 'billing_cycle_day'
234
+ @_hash['billing_cycle_anchor_configuration'] =
235
+ 'billing_cycle_anchor_configuration'
236
+ @_hash['invoicing_threshold'] = 'invoicing_threshold'
237
+ @_hash['price_intervals'] = 'price_intervals'
238
+ @_hash['adjustment_intervals'] = 'adjustment_intervals'
239
+ @_hash['discount_intervals'] = 'discount_intervals'
240
+ @_hash['minimum_intervals'] = 'minimum_intervals'
241
+ @_hash['maximum_intervals'] = 'maximum_intervals'
242
+ @_hash['pending_subscription_change'] = 'pending_subscription_change'
243
+ @_hash['changed_resources'] = 'changed_resources'
244
+ @_hash
245
+ end
246
+
247
+ # An array for optional fields
248
+ def self.optionals
249
+ %w[
250
+ changed_resources
251
+ ]
252
+ end
253
+
254
+ # An array for nullable fields
255
+ def self.nullables
256
+ %w[
257
+ plan
258
+ end_date
259
+ current_billing_period_start_date
260
+ current_billing_period_end_date
261
+ active_plan_phase_order
262
+ default_invoice_memo
263
+ auto_collection
264
+ auto_issuance
265
+ redeemed_coupon
266
+ invoicing_threshold
267
+ pending_subscription_change
268
+ changed_resources
269
+ ]
270
+ end
271
+
272
+ def initialize(metadata:, id:, customer:, plan:, name:, start_date:,
273
+ end_date:, created_at:, current_billing_period_start_date:,
274
+ current_billing_period_end_date:, status:, trial_info:,
275
+ active_plan_phase_order:, fixed_fee_quantity_schedule:,
276
+ default_invoice_memo:, auto_collection:, auto_issuance:,
277
+ net_terms:, redeemed_coupon:, billing_cycle_day:,
278
+ billing_cycle_anchor_configuration:, invoicing_threshold:,
279
+ price_intervals:, adjustment_intervals:, discount_intervals:,
280
+ minimum_intervals:, maximum_intervals:,
281
+ pending_subscription_change:, changed_resources: SKIP,
282
+ additional_properties: nil)
283
+ # Add additional model properties to the instance
284
+ additional_properties = {} if additional_properties.nil?
285
+
286
+ @metadata = metadata
287
+ @id = id
288
+ @customer = customer
289
+ @plan = plan
290
+ @name = name
291
+ @start_date = start_date
292
+ @end_date = end_date
293
+ @created_at = created_at
294
+ @current_billing_period_start_date = current_billing_period_start_date
295
+ @current_billing_period_end_date = current_billing_period_end_date
296
+ @status = status
297
+ @trial_info = trial_info
298
+ @active_plan_phase_order = active_plan_phase_order
299
+ @fixed_fee_quantity_schedule = fixed_fee_quantity_schedule
300
+ @default_invoice_memo = default_invoice_memo
301
+ @auto_collection = auto_collection
302
+ @auto_issuance = auto_issuance
303
+ @net_terms = net_terms
304
+ @redeemed_coupon = redeemed_coupon
305
+ @billing_cycle_day = billing_cycle_day
306
+ @billing_cycle_anchor_configuration = billing_cycle_anchor_configuration
307
+ @invoicing_threshold = invoicing_threshold
308
+ @price_intervals = price_intervals
309
+ @adjustment_intervals = adjustment_intervals
310
+ @discount_intervals = discount_intervals
311
+ @minimum_intervals = minimum_intervals
312
+ @maximum_intervals = maximum_intervals
313
+ @pending_subscription_change = pending_subscription_change
314
+ @changed_resources = changed_resources unless changed_resources == SKIP
315
+ @additional_properties = additional_properties
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
+ metadata = hash.key?('metadata') ? hash['metadata'] : nil
324
+ id = hash.key?('id') ? hash['id'] : nil
325
+ customer = Customer.from_hash(hash['customer']) if hash['customer']
326
+ plan = Plan.from_hash(hash['plan']) if hash['plan']
327
+ name = hash.key?('name') ? hash['name'] : nil
328
+ start_date = if hash.key?('start_date')
329
+ (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
330
+ end
331
+ end_date = if hash.key?('end_date')
332
+ (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
333
+ end
334
+ created_at = if hash.key?('created_at')
335
+ (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
336
+ end
337
+ current_billing_period_start_date = if hash.key?('current_billing_period_start_date')
338
+ (DateTimeHelper.from_rfc3339(hash['current_billing_period_start_date']) if hash['current_billing_period_start_date'])
339
+ end
340
+ current_billing_period_end_date = if hash.key?('current_billing_period_end_date')
341
+ (DateTimeHelper.from_rfc3339(hash['current_billing_period_end_date']) if hash['current_billing_period_end_date'])
342
+ end
343
+ status = hash.key?('status') ? hash['status'] : nil
344
+ trial_info = SubscriptionTrialInfo.from_hash(hash['trial_info']) if hash['trial_info']
345
+ active_plan_phase_order =
346
+ hash.key?('active_plan_phase_order') ? hash['active_plan_phase_order'] : nil
347
+ # Parameter is an array, so we need to iterate through it
348
+ fixed_fee_quantity_schedule = nil
349
+ unless hash['fixed_fee_quantity_schedule'].nil?
350
+ fixed_fee_quantity_schedule = []
351
+ hash['fixed_fee_quantity_schedule'].each do |structure|
352
+ fixed_fee_quantity_schedule << (FixedFeeQuantityScheduleEntry.from_hash(structure) if structure)
353
+ end
354
+ end
355
+
356
+ fixed_fee_quantity_schedule = nil unless hash.key?('fixed_fee_quantity_schedule')
357
+ default_invoice_memo =
358
+ hash.key?('default_invoice_memo') ? hash['default_invoice_memo'] : nil
359
+ auto_collection =
360
+ hash.key?('auto_collection') ? hash['auto_collection'] : nil
361
+ auto_issuance = hash.key?('auto_issuance') ? hash['auto_issuance'] : nil
362
+ net_terms = hash.key?('net_terms') ? hash['net_terms'] : nil
363
+ redeemed_coupon = CouponRedemption.from_hash(hash['redeemed_coupon']) if
364
+ hash['redeemed_coupon']
365
+ billing_cycle_day =
366
+ hash.key?('billing_cycle_day') ? hash['billing_cycle_day'] : nil
367
+ if hash['billing_cycle_anchor_configuration']
368
+ billing_cycle_anchor_configuration = BillingCycleAnchorConfiguration.from_hash(hash['billing_cycle_anchor_configuration'])
369
+ end
370
+ invoicing_threshold =
371
+ hash.key?('invoicing_threshold') ? hash['invoicing_threshold'] : nil
372
+ # Parameter is an array, so we need to iterate through it
373
+ price_intervals = nil
374
+ unless hash['price_intervals'].nil?
375
+ price_intervals = []
376
+ hash['price_intervals'].each do |structure|
377
+ price_intervals << (PriceInterval.from_hash(structure) if structure)
378
+ end
379
+ end
380
+
381
+ price_intervals = nil unless hash.key?('price_intervals')
382
+ # Parameter is an array, so we need to iterate through it
383
+ adjustment_intervals = nil
384
+ unless hash['adjustment_intervals'].nil?
385
+ adjustment_intervals = []
386
+ hash['adjustment_intervals'].each do |structure|
387
+ adjustment_intervals << (AdjustmentInterval.from_hash(structure) if structure)
388
+ end
389
+ end
390
+
391
+ adjustment_intervals = nil unless hash.key?('adjustment_intervals')
392
+ discount_intervals = hash.key?('discount_intervals') ? APIHelper.deserialize_union_type(
393
+ UnionTypeLookUp.get(:MutatedSubscriptionDiscountIntervals), hash['discount_intervals']
394
+ ) : nil
395
+ # Parameter is an array, so we need to iterate through it
396
+ minimum_intervals = nil
397
+ unless hash['minimum_intervals'].nil?
398
+ minimum_intervals = []
399
+ hash['minimum_intervals'].each do |structure|
400
+ minimum_intervals << (MinimumInterval.from_hash(structure) if structure)
401
+ end
402
+ end
403
+
404
+ minimum_intervals = nil unless hash.key?('minimum_intervals')
405
+ # Parameter is an array, so we need to iterate through it
406
+ maximum_intervals = nil
407
+ unless hash['maximum_intervals'].nil?
408
+ maximum_intervals = []
409
+ hash['maximum_intervals'].each do |structure|
410
+ maximum_intervals << (MaximumInterval.from_hash(structure) if structure)
411
+ end
412
+ end
413
+
414
+ maximum_intervals = nil unless hash.key?('maximum_intervals')
415
+ if hash['pending_subscription_change']
416
+ pending_subscription_change = SubscriptionChangeMinified.from_hash(hash['pending_subscription_change'])
417
+ end
418
+ changed_resources = ChangedSubscriptionResources.from_hash(hash['changed_resources']) if
419
+ hash['changed_resources']
420
+
421
+ # Create a new hash for additional properties, removing known properties.
422
+ new_hash = hash.reject { |k, _| names.value?(k) }
423
+
424
+ additional_properties = APIHelper.get_additional_properties(
425
+ new_hash, proc { |value| value }
426
+ )
427
+
428
+ # Create object from extracted values.
429
+ MutatedSubscription.new(metadata: metadata,
430
+ id: id,
431
+ customer: customer,
432
+ plan: plan,
433
+ name: name,
434
+ start_date: start_date,
435
+ end_date: end_date,
436
+ created_at: created_at,
437
+ current_billing_period_start_date: current_billing_period_start_date,
438
+ current_billing_period_end_date: current_billing_period_end_date,
439
+ status: status,
440
+ trial_info: trial_info,
441
+ active_plan_phase_order: active_plan_phase_order,
442
+ fixed_fee_quantity_schedule: fixed_fee_quantity_schedule,
443
+ default_invoice_memo: default_invoice_memo,
444
+ auto_collection: auto_collection,
445
+ auto_issuance: auto_issuance,
446
+ net_terms: net_terms,
447
+ redeemed_coupon: redeemed_coupon,
448
+ billing_cycle_day: billing_cycle_day,
449
+ billing_cycle_anchor_configuration: billing_cycle_anchor_configuration,
450
+ invoicing_threshold: invoicing_threshold,
451
+ price_intervals: price_intervals,
452
+ adjustment_intervals: adjustment_intervals,
453
+ discount_intervals: discount_intervals,
454
+ minimum_intervals: minimum_intervals,
455
+ maximum_intervals: maximum_intervals,
456
+ pending_subscription_change: pending_subscription_change,
457
+ changed_resources: changed_resources,
458
+ additional_properties: additional_properties)
459
+ end
460
+
461
+ def to_custom_start_date
462
+ DateTimeHelper.to_rfc3339(start_date)
463
+ end
464
+
465
+ def to_custom_end_date
466
+ DateTimeHelper.to_rfc3339(end_date)
467
+ end
468
+
469
+ def to_custom_created_at
470
+ DateTimeHelper.to_rfc3339(created_at)
471
+ end
472
+
473
+ def to_custom_current_billing_period_start_date
474
+ DateTimeHelper.to_rfc3339(current_billing_period_start_date)
475
+ end
476
+
477
+ def to_custom_current_billing_period_end_date
478
+ DateTimeHelper.to_rfc3339(current_billing_period_end_date)
479
+ end
480
+
481
+ # Validates an instance of the object from a given value.
482
+ # @param [MutatedSubscription | Hash] The value against the validation is performed.
483
+ def self.validate(value)
484
+ if value.instance_of? self
485
+ return (
486
+ APIHelper.valid_type?(value.metadata,
487
+ ->(val) { val.instance_of? String }) and
488
+ APIHelper.valid_type?(value.id,
489
+ ->(val) { val.instance_of? String }) and
490
+ APIHelper.valid_type?(value.customer,
491
+ ->(val) { Customer.validate(val) },
492
+ is_model_hash: true) and
493
+ APIHelper.valid_type?(value.plan,
494
+ ->(val) { Plan.validate(val) },
495
+ is_model_hash: true) and
496
+ APIHelper.valid_type?(value.name,
497
+ ->(val) { val.instance_of? String }) and
498
+ APIHelper.valid_type?(value.start_date,
499
+ ->(val) { val.instance_of? DateTime }) and
500
+ APIHelper.valid_type?(value.end_date,
501
+ ->(val) { val.instance_of? DateTime }) and
502
+ APIHelper.valid_type?(value.created_at,
503
+ ->(val) { val.instance_of? DateTime }) and
504
+ APIHelper.valid_type?(value.current_billing_period_start_date,
505
+ ->(val) { val.instance_of? DateTime }) and
506
+ APIHelper.valid_type?(value.current_billing_period_end_date,
507
+ ->(val) { val.instance_of? DateTime }) and
508
+ APIHelper.valid_type?(value.status,
509
+ ->(val) { Status13.validate(val) }) and
510
+ APIHelper.valid_type?(value.trial_info,
511
+ ->(val) { SubscriptionTrialInfo.validate(val) },
512
+ is_model_hash: true) and
513
+ APIHelper.valid_type?(value.active_plan_phase_order,
514
+ ->(val) { val.instance_of? Integer }) and
515
+ APIHelper.valid_type?(value.fixed_fee_quantity_schedule,
516
+ ->(val) { FixedFeeQuantityScheduleEntry.validate(val) },
517
+ is_model_hash: true,
518
+ is_inner_model_hash: true) and
519
+ APIHelper.valid_type?(value.default_invoice_memo,
520
+ ->(val) { val.instance_of? String }) and
521
+ APIHelper.valid_type?(value.auto_collection,
522
+ ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
523
+ APIHelper.valid_type?(value.auto_issuance,
524
+ ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
525
+ APIHelper.valid_type?(value.net_terms,
526
+ ->(val) { val.instance_of? Integer }) and
527
+ APIHelper.valid_type?(value.redeemed_coupon,
528
+ ->(val) { CouponRedemption.validate(val) },
529
+ is_model_hash: true) and
530
+ APIHelper.valid_type?(value.billing_cycle_day,
531
+ ->(val) { val.instance_of? Integer }) and
532
+ APIHelper.valid_type?(value.billing_cycle_anchor_configuration,
533
+ ->(val) { BillingCycleAnchorConfiguration.validate(val) },
534
+ is_model_hash: true) and
535
+ APIHelper.valid_type?(value.invoicing_threshold,
536
+ ->(val) { val.instance_of? String }) and
537
+ APIHelper.valid_type?(value.price_intervals,
538
+ ->(val) { PriceInterval.validate(val) },
539
+ is_model_hash: true,
540
+ is_inner_model_hash: true) and
541
+ APIHelper.valid_type?(value.adjustment_intervals,
542
+ ->(val) { AdjustmentInterval.validate(val) },
543
+ is_model_hash: true,
544
+ is_inner_model_hash: true) and
545
+ UnionTypeLookUp.get(:MutatedSubscriptionDiscountIntervals)
546
+ .validate(value.discount_intervals) and
547
+ APIHelper.valid_type?(value.minimum_intervals,
548
+ ->(val) { MinimumInterval.validate(val) },
549
+ is_model_hash: true,
550
+ is_inner_model_hash: true) and
551
+ APIHelper.valid_type?(value.maximum_intervals,
552
+ ->(val) { MaximumInterval.validate(val) },
553
+ is_model_hash: true,
554
+ is_inner_model_hash: true) and
555
+ APIHelper.valid_type?(value.pending_subscription_change,
556
+ ->(val) { SubscriptionChangeMinified.validate(val) },
557
+ is_model_hash: true)
558
+ )
559
+ end
560
+
561
+ return false unless value.instance_of? Hash
562
+
563
+ (
564
+ APIHelper.valid_type?(value['metadata'],
565
+ ->(val) { val.instance_of? String }) and
566
+ APIHelper.valid_type?(value['id'],
567
+ ->(val) { val.instance_of? String }) and
568
+ APIHelper.valid_type?(value['customer'],
569
+ ->(val) { Customer.validate(val) },
570
+ is_model_hash: true) and
571
+ APIHelper.valid_type?(value['plan'],
572
+ ->(val) { Plan.validate(val) },
573
+ is_model_hash: true) and
574
+ APIHelper.valid_type?(value['name'],
575
+ ->(val) { val.instance_of? String }) and
576
+ APIHelper.valid_type?(value['start_date'],
577
+ ->(val) { val.instance_of? String }) and
578
+ APIHelper.valid_type?(value['end_date'],
579
+ ->(val) { val.instance_of? String }) and
580
+ APIHelper.valid_type?(value['created_at'],
581
+ ->(val) { val.instance_of? String }) and
582
+ APIHelper.valid_type?(value['current_billing_period_start_date'],
583
+ ->(val) { val.instance_of? String }) and
584
+ APIHelper.valid_type?(value['current_billing_period_end_date'],
585
+ ->(val) { val.instance_of? String }) and
586
+ APIHelper.valid_type?(value['status'],
587
+ ->(val) { Status13.validate(val) }) and
588
+ APIHelper.valid_type?(value['trial_info'],
589
+ ->(val) { SubscriptionTrialInfo.validate(val) },
590
+ is_model_hash: true) and
591
+ APIHelper.valid_type?(value['active_plan_phase_order'],
592
+ ->(val) { val.instance_of? Integer }) and
593
+ APIHelper.valid_type?(value['fixed_fee_quantity_schedule'],
594
+ ->(val) { FixedFeeQuantityScheduleEntry.validate(val) },
595
+ is_model_hash: true,
596
+ is_inner_model_hash: true) and
597
+ APIHelper.valid_type?(value['default_invoice_memo'],
598
+ ->(val) { val.instance_of? String }) and
599
+ APIHelper.valid_type?(value['auto_collection'],
600
+ ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
601
+ APIHelper.valid_type?(value['auto_issuance'],
602
+ ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
603
+ APIHelper.valid_type?(value['net_terms'],
604
+ ->(val) { val.instance_of? Integer }) and
605
+ APIHelper.valid_type?(value['redeemed_coupon'],
606
+ ->(val) { CouponRedemption.validate(val) },
607
+ is_model_hash: true) and
608
+ APIHelper.valid_type?(value['billing_cycle_day'],
609
+ ->(val) { val.instance_of? Integer }) and
610
+ APIHelper.valid_type?(value['billing_cycle_anchor_configuration'],
611
+ ->(val) { BillingCycleAnchorConfiguration.validate(val) },
612
+ is_model_hash: true) and
613
+ APIHelper.valid_type?(value['invoicing_threshold'],
614
+ ->(val) { val.instance_of? String }) and
615
+ APIHelper.valid_type?(value['price_intervals'],
616
+ ->(val) { PriceInterval.validate(val) },
617
+ is_model_hash: true,
618
+ is_inner_model_hash: true) and
619
+ APIHelper.valid_type?(value['adjustment_intervals'],
620
+ ->(val) { AdjustmentInterval.validate(val) },
621
+ is_model_hash: true,
622
+ is_inner_model_hash: true) and
623
+ UnionTypeLookUp.get(:MutatedSubscriptionDiscountIntervals)
624
+ .validate(value['discount_intervals']) and
625
+ APIHelper.valid_type?(value['minimum_intervals'],
626
+ ->(val) { MinimumInterval.validate(val) },
627
+ is_model_hash: true,
628
+ is_inner_model_hash: true) and
629
+ APIHelper.valid_type?(value['maximum_intervals'],
630
+ ->(val) { MaximumInterval.validate(val) },
631
+ is_model_hash: true,
632
+ is_inner_model_hash: true) and
633
+ APIHelper.valid_type?(value['pending_subscription_change'],
634
+ ->(val) { SubscriptionChangeMinified.validate(val) },
635
+ is_model_hash: true)
636
+ )
637
+ end
638
+
639
+ # Provides a human-readable string representation of the object.
640
+ def to_s
641
+ class_name = self.class.name.split('::').last
642
+ "<#{class_name} metadata: #{@metadata}, id: #{@id}, customer: #{@customer}, plan: #{@plan},"\
643
+ " name: #{@name}, start_date: #{@start_date}, end_date: #{@end_date}, created_at:"\
644
+ " #{@created_at}, current_billing_period_start_date: #{@current_billing_period_start_date},"\
645
+ " current_billing_period_end_date: #{@current_billing_period_end_date}, status: #{@status},"\
646
+ " trial_info: #{@trial_info}, active_plan_phase_order: #{@active_plan_phase_order},"\
647
+ " fixed_fee_quantity_schedule: #{@fixed_fee_quantity_schedule}, default_invoice_memo:"\
648
+ " #{@default_invoice_memo}, auto_collection: #{@auto_collection}, auto_issuance:"\
649
+ " #{@auto_issuance}, net_terms: #{@net_terms}, redeemed_coupon: #{@redeemed_coupon},"\
650
+ " billing_cycle_day: #{@billing_cycle_day}, billing_cycle_anchor_configuration:"\
651
+ " #{@billing_cycle_anchor_configuration}, invoicing_threshold: #{@invoicing_threshold},"\
652
+ " price_intervals: #{@price_intervals}, adjustment_intervals: #{@adjustment_intervals},"\
653
+ " discount_intervals: #{@discount_intervals}, minimum_intervals: #{@minimum_intervals},"\
654
+ " maximum_intervals: #{@maximum_intervals}, pending_subscription_change:"\
655
+ " #{@pending_subscription_change}, changed_resources: #{@changed_resources},"\
656
+ " additional_properties: #{@additional_properties}>"
657
+ end
658
+
659
+ # Provides a debugging-friendly string with detailed object information.
660
+ def inspect
661
+ class_name = self.class.name.split('::').last
662
+ "<#{class_name} metadata: #{@metadata.inspect}, id: #{@id.inspect}, customer:"\
663
+ " #{@customer.inspect}, plan: #{@plan.inspect}, name: #{@name.inspect}, start_date:"\
664
+ " #{@start_date.inspect}, end_date: #{@end_date.inspect}, created_at:"\
665
+ " #{@created_at.inspect}, current_billing_period_start_date:"\
666
+ " #{@current_billing_period_start_date.inspect}, current_billing_period_end_date:"\
667
+ " #{@current_billing_period_end_date.inspect}, status: #{@status.inspect}, trial_info:"\
668
+ " #{@trial_info.inspect}, active_plan_phase_order: #{@active_plan_phase_order.inspect},"\
669
+ " fixed_fee_quantity_schedule: #{@fixed_fee_quantity_schedule.inspect},"\
670
+ " default_invoice_memo: #{@default_invoice_memo.inspect}, auto_collection:"\
671
+ " #{@auto_collection.inspect}, auto_issuance: #{@auto_issuance.inspect}, net_terms:"\
672
+ " #{@net_terms.inspect}, redeemed_coupon: #{@redeemed_coupon.inspect}, billing_cycle_day:"\
673
+ " #{@billing_cycle_day.inspect}, billing_cycle_anchor_configuration:"\
674
+ " #{@billing_cycle_anchor_configuration.inspect}, invoicing_threshold:"\
675
+ " #{@invoicing_threshold.inspect}, price_intervals: #{@price_intervals.inspect},"\
676
+ " adjustment_intervals: #{@adjustment_intervals.inspect}, discount_intervals:"\
677
+ " #{@discount_intervals.inspect}, minimum_intervals: #{@minimum_intervals.inspect},"\
678
+ " maximum_intervals: #{@maximum_intervals.inspect}, pending_subscription_change:"\
679
+ " #{@pending_subscription_change.inspect}, changed_resources: #{@changed_resources.inspect},"\
680
+ " additional_properties: #{@additional_properties}>"
681
+ end
682
+ end
683
+ end