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,501 @@
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
+ # The [Plan](/core-concepts#plan-and-price) resource represents a plan that
9
+ # can be subscribed to by a customer. Plans define the billing behavior of the
10
+ # subscription. You can see more about how to configure prices in the [Price
11
+ # resource](/reference/price).
12
+ class Plan < BaseModel
13
+ SKIP = Object.new
14
+ private_constant :SKIP
15
+
16
+ # User specified key-value pairs for the resource. If not present, this
17
+ # defaults to an empty dictionary. Individual keys can be removed by setting
18
+ # the value to `null`, and the entire metadata mapping can be cleared by
19
+ # setting `metadata` to `null`.
20
+ # @return [Hash[String, String]]
21
+ attr_accessor :metadata
22
+
23
+ # User specified key-value pairs for the resource. If not present, this
24
+ # defaults to an empty dictionary. Individual keys can be removed by setting
25
+ # the value to `null`, and the entire metadata mapping can be cleared by
26
+ # setting `metadata` to `null`.
27
+ # @return [String]
28
+ attr_accessor :id
29
+
30
+ # User specified key-value pairs for the resource. If not present, this
31
+ # defaults to an empty dictionary. Individual keys can be removed by setting
32
+ # the value to `null`, and the entire metadata mapping can be cleared by
33
+ # setting `metadata` to `null`.
34
+ # @return [String]
35
+ attr_accessor :name
36
+
37
+ # User specified key-value pairs for the resource. If not present, this
38
+ # defaults to an empty dictionary. Individual keys can be removed by setting
39
+ # the value to `null`, and the entire metadata mapping can be cleared by
40
+ # setting `metadata` to `null`.
41
+ # @return [String]
42
+ attr_accessor :description
43
+
44
+ # User specified key-value pairs for the resource. If not present, this
45
+ # defaults to an empty dictionary. Individual keys can be removed by setting
46
+ # the value to `null`, and the entire metadata mapping can be cleared by
47
+ # setting `metadata` to `null`.
48
+ # @return [String]
49
+ attr_accessor :maximum_amount
50
+
51
+ # User specified key-value pairs for the resource. If not present, this
52
+ # defaults to an empty dictionary. Individual keys can be removed by setting
53
+ # the value to `null`, and the entire metadata mapping can be cleared by
54
+ # setting `metadata` to `null`.
55
+ # @return [String]
56
+ attr_accessor :minimum_amount
57
+
58
+ # User specified key-value pairs for the resource. If not present, this
59
+ # defaults to an empty dictionary. Individual keys can be removed by setting
60
+ # the value to `null`, and the entire metadata mapping can be cleared by
61
+ # setting `metadata` to `null`.
62
+ # @return [DateTime]
63
+ attr_accessor :created_at
64
+
65
+ # User specified key-value pairs for the resource. If not present, this
66
+ # defaults to an empty dictionary. Individual keys can be removed by setting
67
+ # the value to `null`, and the entire metadata mapping can be cleared by
68
+ # setting `metadata` to `null`.
69
+ # @return [Status]
70
+ attr_accessor :status
71
+
72
+ # User specified key-value pairs for the resource. If not present, this
73
+ # defaults to an empty dictionary. Individual keys can be removed by setting
74
+ # the value to `null`, and the entire metadata mapping can be cleared by
75
+ # setting `metadata` to `null`.
76
+ # @return [Maximum]
77
+ attr_accessor :maximum
78
+
79
+ # User specified key-value pairs for the resource. If not present, this
80
+ # defaults to an empty dictionary. Individual keys can be removed by setting
81
+ # the value to `null`, and the entire metadata mapping can be cleared by
82
+ # setting `metadata` to `null`.
83
+ # @return [Minimum]
84
+ attr_accessor :minimum
85
+
86
+ # User specified key-value pairs for the resource. If not present, this
87
+ # defaults to an empty dictionary. Individual keys can be removed by setting
88
+ # the value to `null`, and the entire metadata mapping can be cleared by
89
+ # setting `metadata` to `null`.
90
+ # @return [Object]
91
+ attr_accessor :discount
92
+
93
+ # User specified key-value pairs for the resource. If not present, this
94
+ # defaults to an empty dictionary. Individual keys can be removed by setting
95
+ # the value to `null`, and the entire metadata mapping can be cleared by
96
+ # setting `metadata` to `null`.
97
+ # @return [Product]
98
+ attr_accessor :product
99
+
100
+ # User specified key-value pairs for the resource. If not present, this
101
+ # defaults to an empty dictionary. Individual keys can be removed by setting
102
+ # the value to `null`, and the entire metadata mapping can be cleared by
103
+ # setting `metadata` to `null`.
104
+ # @return [Integer]
105
+ attr_accessor :version
106
+
107
+ # User specified key-value pairs for the resource. If not present, this
108
+ # defaults to an empty dictionary. Individual keys can be removed by setting
109
+ # the value to `null`, and the entire metadata mapping can be cleared by
110
+ # setting `metadata` to `null`.
111
+ # @return [TrialConfig]
112
+ attr_accessor :trial_config
113
+
114
+ # User specified key-value pairs for the resource. If not present, this
115
+ # defaults to an empty dictionary. Individual keys can be removed by setting
116
+ # the value to `null`, and the entire metadata mapping can be cleared by
117
+ # setting `metadata` to `null`.
118
+ # @return [Array[PlanPhase]]
119
+ attr_accessor :plan_phases
120
+
121
+ # Legacy field representing the parent plan if the current plan is a 'child
122
+ # plan', overriding prices from the parent.
123
+ # @return [PlanMinified]
124
+ attr_accessor :base_plan
125
+
126
+ # Legacy field representing the parent plan ID if the current plan is a
127
+ # 'child plan', overriding prices from the parent.
128
+ # @return [String]
129
+ attr_accessor :base_plan_id
130
+
131
+ # An optional user-defined ID for this plan resource, used throughout the
132
+ # system as an alias for this Plan. Use this field to identify a plan by an
133
+ # existing identifier in your system.
134
+ # @return [String]
135
+ attr_accessor :external_plan_id
136
+
137
+ # An ISO 4217 currency string or custom pricing unit (`credits`) for this
138
+ # plan's prices.
139
+ # @return [String]
140
+ attr_accessor :currency
141
+
142
+ # An ISO 4217 currency string for which this plan is billed in. Matches
143
+ # `currency` unless `currency` is a custom pricing unit.
144
+ # @return [String]
145
+ attr_accessor :invoicing_currency
146
+
147
+ # Determines the difference between the invoice issue date and the due date.
148
+ # A value of "0" here signifies that invoices are due on issue, whereas a
149
+ # value of "30" means that the customer has a month to pay the invoice
150
+ # before its overdue. Note that individual subscriptions or invoices may set
151
+ # a different net terms configuration.
152
+ # @return [Integer]
153
+ attr_accessor :net_terms
154
+
155
+ # The default memo text on the invoices corresponding to subscriptions on
156
+ # this plan. Note that each subscription may configure its own memo.
157
+ # @return [String]
158
+ attr_accessor :default_invoice_memo
159
+
160
+ # Prices for this plan. If the plan has phases, this includes prices across
161
+ # all phases of the plan.
162
+ # @return [Array[Object]]
163
+ attr_accessor :prices
164
+
165
+ # Adjustments for this plan. If the plan has phases, this includes
166
+ # adjustments across all phases of the plan.
167
+ # @return [Array[Object]]
168
+ attr_accessor :adjustments
169
+
170
+ # A mapping from model property names to API property names.
171
+ def self.names
172
+ @_hash = {} if @_hash.nil?
173
+ @_hash['metadata'] = 'metadata'
174
+ @_hash['id'] = 'id'
175
+ @_hash['name'] = 'name'
176
+ @_hash['description'] = 'description'
177
+ @_hash['maximum_amount'] = 'maximum_amount'
178
+ @_hash['minimum_amount'] = 'minimum_amount'
179
+ @_hash['created_at'] = 'created_at'
180
+ @_hash['status'] = 'status'
181
+ @_hash['maximum'] = 'maximum'
182
+ @_hash['minimum'] = 'minimum'
183
+ @_hash['discount'] = 'discount'
184
+ @_hash['product'] = 'product'
185
+ @_hash['version'] = 'version'
186
+ @_hash['trial_config'] = 'trial_config'
187
+ @_hash['plan_phases'] = 'plan_phases'
188
+ @_hash['base_plan'] = 'base_plan'
189
+ @_hash['base_plan_id'] = 'base_plan_id'
190
+ @_hash['external_plan_id'] = 'external_plan_id'
191
+ @_hash['currency'] = 'currency'
192
+ @_hash['invoicing_currency'] = 'invoicing_currency'
193
+ @_hash['net_terms'] = 'net_terms'
194
+ @_hash['default_invoice_memo'] = 'default_invoice_memo'
195
+ @_hash['prices'] = 'prices'
196
+ @_hash['adjustments'] = 'adjustments'
197
+ @_hash
198
+ end
199
+
200
+ # An array for optional fields
201
+ def self.optionals
202
+ []
203
+ end
204
+
205
+ # An array for nullable fields
206
+ def self.nullables
207
+ %w[
208
+ maximum_amount
209
+ minimum_amount
210
+ maximum
211
+ minimum
212
+ discount
213
+ plan_phases
214
+ base_plan
215
+ base_plan_id
216
+ external_plan_id
217
+ net_terms
218
+ default_invoice_memo
219
+ ]
220
+ end
221
+
222
+ def initialize(metadata:, id:, name:, description:, maximum_amount:,
223
+ minimum_amount:, created_at:, status:, maximum:, minimum:,
224
+ discount:, product:, version:, trial_config:, plan_phases:,
225
+ base_plan:, base_plan_id:, external_plan_id:, currency:,
226
+ invoicing_currency:, net_terms:, default_invoice_memo:,
227
+ prices:, adjustments:, additional_properties: nil)
228
+ # Add additional model properties to the instance
229
+ additional_properties = {} if additional_properties.nil?
230
+
231
+ @metadata = metadata
232
+ @id = id
233
+ @name = name
234
+ @description = description
235
+ @maximum_amount = maximum_amount
236
+ @minimum_amount = minimum_amount
237
+ @created_at = created_at
238
+ @status = status
239
+ @maximum = maximum
240
+ @minimum = minimum
241
+ @discount = discount
242
+ @product = product
243
+ @version = version
244
+ @trial_config = trial_config
245
+ @plan_phases = plan_phases
246
+ @base_plan = base_plan
247
+ @base_plan_id = base_plan_id
248
+ @external_plan_id = external_plan_id
249
+ @currency = currency
250
+ @invoicing_currency = invoicing_currency
251
+ @net_terms = net_terms
252
+ @default_invoice_memo = default_invoice_memo
253
+ @prices = prices
254
+ @adjustments = adjustments
255
+ @additional_properties = additional_properties
256
+ end
257
+
258
+ # Creates an instance of the object from a hash.
259
+ def self.from_hash(hash)
260
+ return nil unless hash
261
+
262
+ # Extract variables from the hash.
263
+ metadata = hash.key?('metadata') ? hash['metadata'] : nil
264
+ id = hash.key?('id') ? hash['id'] : nil
265
+ name = hash.key?('name') ? hash['name'] : nil
266
+ description = hash.key?('description') ? hash['description'] : nil
267
+ maximum_amount =
268
+ hash.key?('maximum_amount') ? hash['maximum_amount'] : nil
269
+ minimum_amount =
270
+ hash.key?('minimum_amount') ? hash['minimum_amount'] : nil
271
+ created_at = if hash.key?('created_at')
272
+ (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
273
+ end
274
+ status = hash.key?('status') ? hash['status'] : nil
275
+ maximum = Maximum.from_hash(hash['maximum']) if hash['maximum']
276
+ minimum = Minimum.from_hash(hash['minimum']) if hash['minimum']
277
+ discount = hash.key?('discount') ? hash['discount'] : nil
278
+ product = Product.from_hash(hash['product']) if hash['product']
279
+ version = hash.key?('version') ? hash['version'] : nil
280
+ trial_config = TrialConfig.from_hash(hash['trial_config']) if hash['trial_config']
281
+ # Parameter is an array, so we need to iterate through it
282
+ plan_phases = nil
283
+ unless hash['plan_phases'].nil?
284
+ plan_phases = []
285
+ hash['plan_phases'].each do |structure|
286
+ plan_phases << (PlanPhase.from_hash(structure) if structure)
287
+ end
288
+ end
289
+
290
+ plan_phases = nil unless hash.key?('plan_phases')
291
+ base_plan = PlanMinified.from_hash(hash['base_plan']) if hash['base_plan']
292
+ base_plan_id = hash.key?('base_plan_id') ? hash['base_plan_id'] : nil
293
+ external_plan_id =
294
+ hash.key?('external_plan_id') ? hash['external_plan_id'] : nil
295
+ currency = hash.key?('currency') ? hash['currency'] : nil
296
+ invoicing_currency =
297
+ hash.key?('invoicing_currency') ? hash['invoicing_currency'] : nil
298
+ net_terms = hash.key?('net_terms') ? hash['net_terms'] : nil
299
+ default_invoice_memo =
300
+ hash.key?('default_invoice_memo') ? hash['default_invoice_memo'] : nil
301
+ prices = hash.key?('prices') ? APIHelper.deserialize_union_type(
302
+ UnionTypeLookUp.get(:Price2), hash['prices']
303
+ ) : nil
304
+ adjustments = hash.key?('adjustments') ? APIHelper.deserialize_union_type(
305
+ UnionTypeLookUp.get(:Adjustment2), hash['adjustments']
306
+ ) : nil
307
+
308
+ # Create a new hash for additional properties, removing known properties.
309
+ new_hash = hash.reject { |k, _| names.value?(k) }
310
+
311
+ additional_properties = APIHelper.get_additional_properties(
312
+ new_hash, proc { |value| value }
313
+ )
314
+
315
+ # Create object from extracted values.
316
+ Plan.new(metadata: metadata,
317
+ id: id,
318
+ name: name,
319
+ description: description,
320
+ maximum_amount: maximum_amount,
321
+ minimum_amount: minimum_amount,
322
+ created_at: created_at,
323
+ status: status,
324
+ maximum: maximum,
325
+ minimum: minimum,
326
+ discount: discount,
327
+ product: product,
328
+ version: version,
329
+ trial_config: trial_config,
330
+ plan_phases: plan_phases,
331
+ base_plan: base_plan,
332
+ base_plan_id: base_plan_id,
333
+ external_plan_id: external_plan_id,
334
+ currency: currency,
335
+ invoicing_currency: invoicing_currency,
336
+ net_terms: net_terms,
337
+ default_invoice_memo: default_invoice_memo,
338
+ prices: prices,
339
+ adjustments: adjustments,
340
+ additional_properties: additional_properties)
341
+ end
342
+
343
+ def to_custom_created_at
344
+ DateTimeHelper.to_rfc3339(created_at)
345
+ end
346
+
347
+ # Validates an instance of the object from a given value.
348
+ # @param [Plan | Hash] The value against the validation is performed.
349
+ def self.validate(value)
350
+ if value.instance_of? self
351
+ return (
352
+ APIHelper.valid_type?(value.metadata,
353
+ ->(val) { val.instance_of? String }) and
354
+ APIHelper.valid_type?(value.id,
355
+ ->(val) { val.instance_of? String }) and
356
+ APIHelper.valid_type?(value.name,
357
+ ->(val) { val.instance_of? String }) and
358
+ APIHelper.valid_type?(value.description,
359
+ ->(val) { val.instance_of? String }) and
360
+ APIHelper.valid_type?(value.maximum_amount,
361
+ ->(val) { val.instance_of? String }) and
362
+ APIHelper.valid_type?(value.minimum_amount,
363
+ ->(val) { val.instance_of? String }) and
364
+ APIHelper.valid_type?(value.created_at,
365
+ ->(val) { val.instance_of? DateTime }) and
366
+ APIHelper.valid_type?(value.status,
367
+ ->(val) { Status.validate(val) }) and
368
+ APIHelper.valid_type?(value.maximum,
369
+ ->(val) { Maximum.validate(val) },
370
+ is_model_hash: true) and
371
+ APIHelper.valid_type?(value.minimum,
372
+ ->(val) { Minimum.validate(val) },
373
+ is_model_hash: true) and
374
+ APIHelper.valid_type?(value.discount,
375
+ ->(val) { val.instance_of? Object }) and
376
+ APIHelper.valid_type?(value.product,
377
+ ->(val) { Product.validate(val) },
378
+ is_model_hash: true) and
379
+ APIHelper.valid_type?(value.version,
380
+ ->(val) { val.instance_of? Integer }) and
381
+ APIHelper.valid_type?(value.trial_config,
382
+ ->(val) { TrialConfig.validate(val) },
383
+ is_model_hash: true) and
384
+ APIHelper.valid_type?(value.plan_phases,
385
+ ->(val) { PlanPhase.validate(val) },
386
+ is_model_hash: true,
387
+ is_inner_model_hash: true) and
388
+ APIHelper.valid_type?(value.base_plan,
389
+ ->(val) { PlanMinified.validate(val) },
390
+ is_model_hash: true) and
391
+ APIHelper.valid_type?(value.base_plan_id,
392
+ ->(val) { val.instance_of? String }) and
393
+ APIHelper.valid_type?(value.external_plan_id,
394
+ ->(val) { val.instance_of? String }) and
395
+ APIHelper.valid_type?(value.currency,
396
+ ->(val) { val.instance_of? String }) and
397
+ APIHelper.valid_type?(value.invoicing_currency,
398
+ ->(val) { val.instance_of? String }) and
399
+ APIHelper.valid_type?(value.net_terms,
400
+ ->(val) { val.instance_of? Integer }) and
401
+ APIHelper.valid_type?(value.default_invoice_memo,
402
+ ->(val) { val.instance_of? String }) and
403
+ UnionTypeLookUp.get(:Price2)
404
+ .validate(value.prices) and
405
+ UnionTypeLookUp.get(:Adjustment2)
406
+ .validate(value.adjustments)
407
+ )
408
+ end
409
+
410
+ return false unless value.instance_of? Hash
411
+
412
+ (
413
+ APIHelper.valid_type?(value['metadata'],
414
+ ->(val) { val.instance_of? String }) and
415
+ APIHelper.valid_type?(value['id'],
416
+ ->(val) { val.instance_of? String }) and
417
+ APIHelper.valid_type?(value['name'],
418
+ ->(val) { val.instance_of? String }) and
419
+ APIHelper.valid_type?(value['description'],
420
+ ->(val) { val.instance_of? String }) and
421
+ APIHelper.valid_type?(value['maximum_amount'],
422
+ ->(val) { val.instance_of? String }) and
423
+ APIHelper.valid_type?(value['minimum_amount'],
424
+ ->(val) { val.instance_of? String }) and
425
+ APIHelper.valid_type?(value['created_at'],
426
+ ->(val) { val.instance_of? String }) and
427
+ APIHelper.valid_type?(value['status'],
428
+ ->(val) { Status.validate(val) }) and
429
+ APIHelper.valid_type?(value['maximum'],
430
+ ->(val) { Maximum.validate(val) },
431
+ is_model_hash: true) and
432
+ APIHelper.valid_type?(value['minimum'],
433
+ ->(val) { Minimum.validate(val) },
434
+ is_model_hash: true) and
435
+ APIHelper.valid_type?(value['discount'],
436
+ ->(val) { val.instance_of? Object }) and
437
+ APIHelper.valid_type?(value['product'],
438
+ ->(val) { Product.validate(val) },
439
+ is_model_hash: true) and
440
+ APIHelper.valid_type?(value['version'],
441
+ ->(val) { val.instance_of? Integer }) and
442
+ APIHelper.valid_type?(value['trial_config'],
443
+ ->(val) { TrialConfig.validate(val) },
444
+ is_model_hash: true) and
445
+ APIHelper.valid_type?(value['plan_phases'],
446
+ ->(val) { PlanPhase.validate(val) },
447
+ is_model_hash: true,
448
+ is_inner_model_hash: true) and
449
+ APIHelper.valid_type?(value['base_plan'],
450
+ ->(val) { PlanMinified.validate(val) },
451
+ is_model_hash: true) and
452
+ APIHelper.valid_type?(value['base_plan_id'],
453
+ ->(val) { val.instance_of? String }) and
454
+ APIHelper.valid_type?(value['external_plan_id'],
455
+ ->(val) { val.instance_of? String }) and
456
+ APIHelper.valid_type?(value['currency'],
457
+ ->(val) { val.instance_of? String }) and
458
+ APIHelper.valid_type?(value['invoicing_currency'],
459
+ ->(val) { val.instance_of? String }) and
460
+ APIHelper.valid_type?(value['net_terms'],
461
+ ->(val) { val.instance_of? Integer }) and
462
+ APIHelper.valid_type?(value['default_invoice_memo'],
463
+ ->(val) { val.instance_of? String }) and
464
+ UnionTypeLookUp.get(:Price2)
465
+ .validate(value['prices']) and
466
+ UnionTypeLookUp.get(:Adjustment2)
467
+ .validate(value['adjustments'])
468
+ )
469
+ end
470
+
471
+ # Provides a human-readable string representation of the object.
472
+ def to_s
473
+ class_name = self.class.name.split('::').last
474
+ "<#{class_name} metadata: #{@metadata}, id: #{@id}, name: #{@name}, description:"\
475
+ " #{@description}, maximum_amount: #{@maximum_amount}, minimum_amount: #{@minimum_amount},"\
476
+ " created_at: #{@created_at}, status: #{@status}, maximum: #{@maximum}, minimum:"\
477
+ " #{@minimum}, discount: #{@discount}, product: #{@product}, version: #{@version},"\
478
+ " trial_config: #{@trial_config}, plan_phases: #{@plan_phases}, base_plan: #{@base_plan},"\
479
+ " base_plan_id: #{@base_plan_id}, external_plan_id: #{@external_plan_id}, currency:"\
480
+ " #{@currency}, invoicing_currency: #{@invoicing_currency}, net_terms: #{@net_terms},"\
481
+ " default_invoice_memo: #{@default_invoice_memo}, prices: #{@prices}, adjustments:"\
482
+ " #{@adjustments}, additional_properties: #{@additional_properties}>"
483
+ end
484
+
485
+ # Provides a debugging-friendly string with detailed object information.
486
+ def inspect
487
+ class_name = self.class.name.split('::').last
488
+ "<#{class_name} metadata: #{@metadata.inspect}, id: #{@id.inspect}, name: #{@name.inspect},"\
489
+ " description: #{@description.inspect}, maximum_amount: #{@maximum_amount.inspect},"\
490
+ " minimum_amount: #{@minimum_amount.inspect}, created_at: #{@created_at.inspect}, status:"\
491
+ " #{@status.inspect}, maximum: #{@maximum.inspect}, minimum: #{@minimum.inspect}, discount:"\
492
+ " #{@discount.inspect}, product: #{@product.inspect}, version: #{@version.inspect},"\
493
+ " trial_config: #{@trial_config.inspect}, plan_phases: #{@plan_phases.inspect}, base_plan:"\
494
+ " #{@base_plan.inspect}, base_plan_id: #{@base_plan_id.inspect}, external_plan_id:"\
495
+ " #{@external_plan_id.inspect}, currency: #{@currency.inspect}, invoicing_currency:"\
496
+ " #{@invoicing_currency.inspect}, net_terms: #{@net_terms.inspect}, default_invoice_memo:"\
497
+ " #{@default_invoice_memo.inspect}, prices: #{@prices.inspect}, adjustments:"\
498
+ " #{@adjustments.inspect}, additional_properties: #{@additional_properties}>"
499
+ end
500
+ end
501
+ end
@@ -0,0 +1,125 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # PlanMinified Model.
8
+ class PlanMinified < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [String]
14
+ attr_accessor :id
15
+
16
+ # An optional user-defined ID for this plan resource, used throughout the
17
+ # system as an alias for this Plan. Use this field to identify a plan by an
18
+ # existing identifier in your system.
19
+ # @return [String]
20
+ attr_accessor :external_plan_id
21
+
22
+ # An optional user-defined ID for this plan resource, used throughout the
23
+ # system as an alias for this Plan. Use this field to identify a plan by an
24
+ # existing identifier in your system.
25
+ # @return [String]
26
+ attr_accessor :name
27
+
28
+ # A mapping from model property names to API property names.
29
+ def self.names
30
+ @_hash = {} if @_hash.nil?
31
+ @_hash['id'] = 'id'
32
+ @_hash['external_plan_id'] = 'external_plan_id'
33
+ @_hash['name'] = 'name'
34
+ @_hash
35
+ end
36
+
37
+ # An array for optional fields
38
+ def self.optionals
39
+ []
40
+ end
41
+
42
+ # An array for nullable fields
43
+ def self.nullables
44
+ %w[
45
+ id
46
+ external_plan_id
47
+ name
48
+ ]
49
+ end
50
+
51
+ def initialize(id:, external_plan_id:, name:, additional_properties: nil)
52
+ # Add additional model properties to the instance
53
+ additional_properties = {} if additional_properties.nil?
54
+
55
+ @id = id
56
+ @external_plan_id = external_plan_id
57
+ @name = name
58
+ @additional_properties = additional_properties
59
+ end
60
+
61
+ # Creates an instance of the object from a hash.
62
+ def self.from_hash(hash)
63
+ return nil unless hash
64
+
65
+ # Extract variables from the hash.
66
+ id = hash.key?('id') ? hash['id'] : nil
67
+ external_plan_id =
68
+ hash.key?('external_plan_id') ? hash['external_plan_id'] : nil
69
+ name = hash.key?('name') ? hash['name'] : nil
70
+
71
+ # Create a new hash for additional properties, removing known properties.
72
+ new_hash = hash.reject { |k, _| names.value?(k) }
73
+
74
+ additional_properties = APIHelper.get_additional_properties(
75
+ new_hash, proc { |value| value }
76
+ )
77
+
78
+ # Create object from extracted values.
79
+ PlanMinified.new(id: id,
80
+ external_plan_id: external_plan_id,
81
+ name: name,
82
+ additional_properties: additional_properties)
83
+ end
84
+
85
+ # Validates an instance of the object from a given value.
86
+ # @param [PlanMinified | Hash] The value against the validation is performed.
87
+ def self.validate(value)
88
+ if value.instance_of? self
89
+ return (
90
+ APIHelper.valid_type?(value.id,
91
+ ->(val) { val.instance_of? String }) and
92
+ APIHelper.valid_type?(value.external_plan_id,
93
+ ->(val) { val.instance_of? String }) and
94
+ APIHelper.valid_type?(value.name,
95
+ ->(val) { val.instance_of? String })
96
+ )
97
+ end
98
+
99
+ return false unless value.instance_of? Hash
100
+
101
+ (
102
+ APIHelper.valid_type?(value['id'],
103
+ ->(val) { val.instance_of? String }) and
104
+ APIHelper.valid_type?(value['external_plan_id'],
105
+ ->(val) { val.instance_of? String }) and
106
+ APIHelper.valid_type?(value['name'],
107
+ ->(val) { val.instance_of? String })
108
+ )
109
+ end
110
+
111
+ # Provides a human-readable string representation of the object.
112
+ def to_s
113
+ class_name = self.class.name.split('::').last
114
+ "<#{class_name} id: #{@id}, external_plan_id: #{@external_plan_id}, name: #{@name},"\
115
+ " additional_properties: #{@additional_properties}>"
116
+ end
117
+
118
+ # Provides a debugging-friendly string with detailed object information.
119
+ def inspect
120
+ class_name = self.class.name.split('::').last
121
+ "<#{class_name} id: #{@id.inspect}, external_plan_id: #{@external_plan_id.inspect}, name:"\
122
+ " #{@name.inspect}, additional_properties: #{@additional_properties}>"
123
+ end
124
+ end
125
+ end