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,224 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # Tax IDs are commonly required to be displayed on customer invoices, which
8
+ # are added to the headers of invoices. ### Supported Tax ID Countries and
9
+ # Types | Country | Type | Description | |---------|------|-------------| |
10
+ # Albania | `al_tin` | Albania Tax Identification Number | | Andorra |
11
+ # `ad_nrt` | Andorran NRT Number | | Angola | `ao_tin` | Angola Tax
12
+ # Identification Number | | Argentina | `ar_cuit` | Argentinian Tax ID Number
13
+ # | | Armenia | `am_tin` | Armenia Tax Identification Number | | Aruba |
14
+ # `aw_tin` | Aruba Tax Identification Number | | Australia | `au_abn` |
15
+ # Australian Business Number (AU ABN) | | Australia | `au_arn` | Australian
16
+ # Taxation Office Reference Number | | Austria | `eu_vat` | European VAT
17
+ # Number | | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number | |
18
+ # Bahamas | `bs_tin` | Bahamas Tax Identification Number | | Bahrain |
19
+ # `bh_vat` | Bahraini VAT Number | | Bangladesh | `bd_bin` | Bangladesh
20
+ # Business Identification Number | | Barbados | `bb_tin` | Barbados Tax
21
+ # Identification Number | | Belarus | `by_tin` | Belarus TIN Number | |
22
+ # Belgium | `eu_vat` | European VAT Number | | Benin | `bj_ifu` | Benin Tax
23
+ # Identification Number (Identifiant Fiscal Unique) | | Bolivia | `bo_tin` |
24
+ # Bolivian Tax ID | | Bosnia and Herzegovina | `ba_tin` | Bosnia and
25
+ # Herzegovina Tax Identification Number | | Brazil | `br_cnpj` | Brazilian
26
+ # CNPJ Number | | Brazil | `br_cpf` | Brazilian CPF Number | | Bulgaria |
27
+ # `bg_uic` | Bulgaria Unified Identification Code | | Bulgaria | `eu_vat` |
28
+ # European VAT Number | | Burkina Faso | `bf_ifu` | Burkina Faso Tax
29
+ # Identification Number (Numéro d'Identifiant Fiscal Unique) | | Cambodia |
30
+ # `kh_tin` | Cambodia Tax Identification Number | | Cameroon | `cm_niu` |
31
+ # Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) | |
32
+ # Canada | `ca_bn` | Canadian BN | | Canada | `ca_gst_hst` | Canadian GST/HST
33
+ # Number | | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | |
34
+ # Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | | Canada |
35
+ # `ca_pst_sk` | Canadian PST Number (Saskatchewan) | | Canada | `ca_qst` |
36
+ # Canadian QST Number (Québec) | | Cape Verde | `cv_nif` | Cape Verde Tax
37
+ # Identification Number (Número de Identificação Fiscal) | | Chile | `cl_tin`
38
+ # | Chilean TIN | | China | `cn_tin` | Chinese Tax ID | | Colombia | `co_nit`
39
+ # | Colombian NIT Number | | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax
40
+ # Identification Number (Número de Identificação Fiscal) | | Costa Rica |
41
+ # `cr_tin` | Costa Rican Tax ID | | Croatia | `eu_vat` | European VAT Number |
42
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) | |
43
+ # Cyprus | `eu_vat` | European VAT Number | | Czech Republic | `eu_vat` |
44
+ # European VAT Number | | Denmark | `eu_vat` | European VAT Number | |
45
+ # Dominican Republic | `do_rcn` | Dominican RCN Number | | Ecuador | `ec_ruc`
46
+ # | Ecuadorian RUC Number | | Egypt | `eg_tin` | Egyptian Tax Identification
47
+ # Number | | El Salvador | `sv_nit` | El Salvadorian NIT Number | | Estonia |
48
+ # `eu_vat` | European VAT Number | | Ethiopia | `et_tin` | Ethiopia Tax
49
+ # Identification Number | | European Union | `eu_oss_vat` | European One Stop
50
+ # Shop VAT Number for non-Union scheme | | Faroe Islands | `fo_vat` | Faroe
51
+ # Islands VAT Number | | Finland | `eu_vat` | European VAT Number | | France |
52
+ # `eu_vat` | European VAT Number | | Georgia | `ge_vat` | Georgian VAT | |
53
+ # Germany | `de_stn` | German Tax Number (Steuernummer) | | Germany | `eu_vat`
54
+ # | European VAT Number | | Gibraltar | `gi_tin` | Gibraltar Tax
55
+ # Identification Number | | Greece | `eu_vat` | European VAT Number | | Guinea
56
+ # | `gn_nif` | Guinea Tax Identification Number (Número de Identificação
57
+ # Fiscal) | | Hong Kong | `hk_br` | Hong Kong BR Number | | Hungary | `eu_vat`
58
+ # | European VAT Number | | Hungary | `hu_tin` | Hungary Tax Number (adószám)
59
+ # | | Iceland | `is_vat` | Icelandic VAT | | India | `in_gst` | Indian GST
60
+ # Number | | Indonesia | `id_npwp` | Indonesian NPWP Number | | Ireland |
61
+ # `eu_vat` | European VAT Number | | Israel | `il_vat` | Israel VAT | | Italy
62
+ # | `eu_vat` | European VAT Number | | Italy | `it_cf` | Italian Codice
63
+ # Fiscale Number | | Japan | `jp_cn` | Japanese Corporate Number (*Hōjin
64
+ # Bangō*) | | Japan | `jp_rn` | Japanese Registered Foreign Businesses'
65
+ # Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*) | | Japan |
66
+ # `jp_trn` | Japanese Tax Registration Number (*Tōroku Bangō*) | | Kazakhstan
67
+ # | `kz_bin` | Kazakhstani Business Identification Number | | Kenya | `ke_pin`
68
+ # | Kenya Revenue Authority Personal Identification Number | | Kyrgyzstan |
69
+ # `kg_tin` | Kyrgyzstan Tax Identification Number | | Laos | `la_tin` | Laos
70
+ # Tax Identification Number | | Latvia | `eu_vat` | European VAT Number | |
71
+ # Liechtenstein | `li_uid` | Liechtensteinian UID Number | | Liechtenstein |
72
+ # `li_vat` | Liechtenstein VAT Number | | Lithuania | `eu_vat` | European VAT
73
+ # Number | | Luxembourg | `eu_vat` | European VAT Number | | Malaysia |
74
+ # `my_frp` | Malaysian FRP Number | | Malaysia | `my_itn` | Malaysian ITN | |
75
+ # Malaysia | `my_sst` | Malaysian SST Number | | Malta | `eu_vat` | European
76
+ # VAT Number | | Mauritania | `mr_nif` | Mauritania Tax Identification Number
77
+ # (Número de Identificação Fiscal) | | Mexico | `mx_rfc` | Mexican RFC Number
78
+ # | | Moldova | `md_vat` | Moldova VAT Number | | Montenegro | `me_pib` |
79
+ # Montenegro PIB Number | | Morocco | `ma_vat` | Morocco VAT Number | | Nepal
80
+ # | `np_pan` | Nepal PAN Number | | Netherlands | `eu_vat` | European VAT
81
+ # Number | | New Zealand | `nz_gst` | New Zealand GST Number | | Nigeria |
82
+ # `ng_tin` | Nigerian Tax Identification Number | | North Macedonia | `mk_vat`
83
+ # | North Macedonia VAT Number | | Northern Ireland | `eu_vat` | Northern
84
+ # Ireland VAT Number | | Norway | `no_vat` | Norwegian VAT Number | | Norway |
85
+ # `no_voec` | Norwegian VAT on e-commerce Number | | Oman | `om_vat` | Omani
86
+ # VAT Number | | Paraguay | `py_ruc` | Paraguayan RUC Number | | Peru |
87
+ # `pe_ruc` | Peruvian RUC Number | | Philippines | `ph_tin` | Philippines Tax
88
+ # Identification Number | | Poland | `eu_vat` | European VAT Number | | Poland
89
+ # | `pl_nip` | Polish Tax ID Number | | Portugal | `eu_vat` | European VAT
90
+ # Number | | Romania | `eu_vat` | European VAT Number | | Romania | `ro_tin` |
91
+ # Romanian Tax ID Number | | Russia | `ru_inn` | Russian INN | | Russia |
92
+ # `ru_kpp` | Russian KPP | | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | |
93
+ # Senegal | `sn_ninea` | Senegal NINEA Number | | Serbia | `rs_pib` | Serbian
94
+ # PIB Number | | Singapore | `sg_gst` | Singaporean GST | | Singapore |
95
+ # `sg_uen` | Singaporean UEN | | Slovakia | `eu_vat` | European VAT Number | |
96
+ # Slovenia | `eu_vat` | European VAT Number | | Slovenia | `si_tin` | Slovenia
97
+ # Tax Number (davčna številka) | | South Africa | `za_vat` | South African VAT
98
+ # Number | | South Korea | `kr_brn` | Korean BRN | | Spain | `es_cif` |
99
+ # Spanish NIF Number (previously Spanish CIF Number) | | Spain | `eu_vat` |
100
+ # European VAT Number | | Sri Lanka | `lk_vat` | Sri Lanka VAT Number | |
101
+ # Suriname | `sr_fin` | Suriname FIN Number | | Sweden | `eu_vat` | European
102
+ # VAT Number | | Switzerland | `ch_uid` | Switzerland UID Number | |
103
+ # Switzerland | `ch_vat` | Switzerland VAT Number | | Taiwan | `tw_vat` |
104
+ # Taiwanese VAT | | Tajikistan | `tj_tin` | Tajikistan Tax Identification
105
+ # Number | | Tanzania | `tz_vat` | Tanzania VAT Number | | Thailand | `th_vat`
106
+ # | Thai VAT | | Turkey | `tr_tin` | Turkish Tax Identification Number | |
107
+ # Uganda | `ug_tin` | Uganda Tax Identification Number | | Ukraine | `ua_vat`
108
+ # | Ukrainian VAT | | United Arab Emirates | `ae_trn` | United Arab Emirates
109
+ # TRN | | United Kingdom | `gb_vat` | United Kingdom VAT Number | | United
110
+ # States | `us_ein` | United States EIN | | Uruguay | `uy_ruc` | Uruguayan RUC
111
+ # Number | | Uzbekistan | `uz_tin` | Uzbekistan TIN Number | | Uzbekistan |
112
+ # `uz_vat` | Uzbekistan VAT Number | | Venezuela | `ve_rif` | Venezuelan RIF
113
+ # Number | | Vietnam | `vn_tin` | Vietnamese Tax ID Number | | Zambia |
114
+ # `zm_tin` | Zambia Tax Identification Number | | Zimbabwe | `zw_tin` |
115
+ # Zimbabwe Tax Identification Number |
116
+ class CustomerTaxId < BaseModel
117
+ SKIP = Object.new
118
+ private_constant :SKIP
119
+
120
+ # TODO: Write general description for this method
121
+ # @return [Country]
122
+ attr_accessor :country
123
+
124
+ # TODO: Write general description for this method
125
+ # @return [Type5]
126
+ attr_accessor :type
127
+
128
+ # TODO: Write general description for this method
129
+ # @return [String]
130
+ attr_accessor :value
131
+
132
+ # A mapping from model property names to API property names.
133
+ def self.names
134
+ @_hash = {} if @_hash.nil?
135
+ @_hash['country'] = 'country'
136
+ @_hash['type'] = 'type'
137
+ @_hash['value'] = 'value'
138
+ @_hash
139
+ end
140
+
141
+ # An array for optional fields
142
+ def self.optionals
143
+ []
144
+ end
145
+
146
+ # An array for nullable fields
147
+ def self.nullables
148
+ []
149
+ end
150
+
151
+ def initialize(country:, type:, value:, additional_properties: nil)
152
+ # Add additional model properties to the instance
153
+ additional_properties = {} if additional_properties.nil?
154
+
155
+ @country = country
156
+ @type = type
157
+ @value = value
158
+ @additional_properties = additional_properties
159
+ end
160
+
161
+ # Creates an instance of the object from a hash.
162
+ def self.from_hash(hash)
163
+ return nil unless hash
164
+
165
+ # Extract variables from the hash.
166
+ country = hash.key?('country') ? hash['country'] : nil
167
+ type = hash.key?('type') ? hash['type'] : nil
168
+ value = hash.key?('value') ? hash['value'] : nil
169
+
170
+ # Create a new hash for additional properties, removing known properties.
171
+ new_hash = hash.reject { |k, _| names.value?(k) }
172
+
173
+ additional_properties = APIHelper.get_additional_properties(
174
+ new_hash, proc { |value| value }
175
+ )
176
+
177
+ # Create object from extracted values.
178
+ CustomerTaxId.new(country: country,
179
+ type: type,
180
+ value: value,
181
+ additional_properties: additional_properties)
182
+ end
183
+
184
+ # Validates an instance of the object from a given value.
185
+ # @param [CustomerTaxId | Hash] The value against the validation is performed.
186
+ def self.validate(value)
187
+ if value.instance_of? self
188
+ return (
189
+ APIHelper.valid_type?(value.country,
190
+ ->(val) { Country.validate(val) }) and
191
+ APIHelper.valid_type?(value.type,
192
+ ->(val) { Type5.validate(val) }) and
193
+ APIHelper.valid_type?(value.value,
194
+ ->(val) { val.instance_of? String })
195
+ )
196
+ end
197
+
198
+ return false unless value.instance_of? Hash
199
+
200
+ (
201
+ APIHelper.valid_type?(value['country'],
202
+ ->(val) { Country.validate(val) }) and
203
+ APIHelper.valid_type?(value['type'],
204
+ ->(val) { Type5.validate(val) }) and
205
+ APIHelper.valid_type?(value['value'],
206
+ ->(val) { val.instance_of? String })
207
+ )
208
+ end
209
+
210
+ # Provides a human-readable string representation of the object.
211
+ def to_s
212
+ class_name = self.class.name.split('::').last
213
+ "<#{class_name} country: #{@country}, type: #{@type}, value: #{@value},"\
214
+ " additional_properties: #{@additional_properties}>"
215
+ end
216
+
217
+ # Provides a debugging-friendly string with detailed object information.
218
+ def inspect
219
+ class_name = self.class.name.split('::').last
220
+ "<#{class_name} country: #{@country.inspect}, type: #{@type.inspect}, value:"\
221
+ " #{@value.inspect}, additional_properties: #{@additional_properties}>"
222
+ end
223
+ end
224
+ end
@@ -0,0 +1,92 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # Customers Model.
8
+ class Customers < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [Array[Customer]]
14
+ attr_accessor :data
15
+
16
+ # TODO: Write general description for this method
17
+ # @return [PaginationMetadata]
18
+ attr_accessor :pagination_metadata
19
+
20
+ # A mapping from model property names to API property names.
21
+ def self.names
22
+ @_hash = {} if @_hash.nil?
23
+ @_hash['data'] = 'data'
24
+ @_hash['pagination_metadata'] = 'pagination_metadata'
25
+ @_hash
26
+ end
27
+
28
+ # An array for optional fields
29
+ def self.optionals
30
+ []
31
+ end
32
+
33
+ # An array for nullable fields
34
+ def self.nullables
35
+ []
36
+ end
37
+
38
+ def initialize(data:, pagination_metadata:, additional_properties: nil)
39
+ # Add additional model properties to the instance
40
+ additional_properties = {} if additional_properties.nil?
41
+
42
+ @data = data
43
+ @pagination_metadata = pagination_metadata
44
+ @additional_properties = additional_properties
45
+ end
46
+
47
+ # Creates an instance of the object from a hash.
48
+ def self.from_hash(hash)
49
+ return nil unless hash
50
+
51
+ # Extract variables from the hash.
52
+ # Parameter is an array, so we need to iterate through it
53
+ data = nil
54
+ unless hash['data'].nil?
55
+ data = []
56
+ hash['data'].each do |structure|
57
+ data << (Customer.from_hash(structure) if structure)
58
+ end
59
+ end
60
+
61
+ data = nil unless hash.key?('data')
62
+ pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
63
+ hash['pagination_metadata']
64
+
65
+ # Create a new hash for additional properties, removing known properties.
66
+ new_hash = hash.reject { |k, _| names.value?(k) }
67
+
68
+ additional_properties = APIHelper.get_additional_properties(
69
+ new_hash, proc { |value| value }
70
+ )
71
+
72
+ # Create object from extracted values.
73
+ Customers.new(data: data,
74
+ pagination_metadata: pagination_metadata,
75
+ additional_properties: additional_properties)
76
+ end
77
+
78
+ # Provides a human-readable string representation of the object.
79
+ def to_s
80
+ class_name = self.class.name.split('::').last
81
+ "<#{class_name} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
82
+ " additional_properties: #{@additional_properties}>"
83
+ end
84
+
85
+ # Provides a debugging-friendly string with detailed object information.
86
+ def inspect
87
+ class_name = self.class.name.split('::').last
88
+ "<#{class_name} data: #{@data.inspect}, pagination_metadata:"\
89
+ " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,119 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # Pricing model that gives a daily credit budget across one or more
8
+ # dimensional rates. Each event is rated in credits at a per-dimension
9
+ # `unit_amount`. Events are bucketed into days via an `event_day_property` set
10
+ # on the event (e.g. an ISO date string in the customer's timezone, supplied
11
+ # at ingest by the customer). Within each day the first `daily_allowance`
12
+ # credits are free; usage beyond that is charged in full. The allowance does
13
+ # not roll over. Use cases: shared daily AI-token budgets where different
14
+ # models have different credit costs.
15
+ class DailyCreditAllowanceConfig < BaseModel
16
+ SKIP = Object.new
17
+ private_constant :SKIP
18
+
19
+ # Event property whose value identifies the day bucket the event belongs to
20
+ # (e.g. 'event_day' set to an ISO date string in the customer's timezone).
21
+ # The allowance resets per distinct value of this property.
22
+ # @return [String]
23
+ attr_accessor :event_day_property
24
+
25
+ # One or two event property values to evaluate matrix groups by
26
+ # @return [Array[String]]
27
+ attr_accessor :dimensions
28
+
29
+ # Default per-unit credit rate for any usage not bucketed into a specified
30
+ # matrix_value
31
+ # @return [String]
32
+ attr_accessor :default_unit_amount
33
+
34
+ # Credits granted per day. Lose-it-or-use-it; does not roll over.
35
+ # @return [String]
36
+ attr_accessor :daily_allowance
37
+
38
+ # Per-dimension credit rates
39
+ # @return [Array[DailyCreditAllowanceMatrixValue]]
40
+ attr_accessor :matrix_values
41
+
42
+ # A mapping from model property names to API property names.
43
+ def self.names
44
+ @_hash = {} if @_hash.nil?
45
+ @_hash['event_day_property'] = 'event_day_property'
46
+ @_hash['dimensions'] = 'dimensions'
47
+ @_hash['default_unit_amount'] = 'default_unit_amount'
48
+ @_hash['daily_allowance'] = 'daily_allowance'
49
+ @_hash['matrix_values'] = 'matrix_values'
50
+ @_hash
51
+ end
52
+
53
+ # An array for optional fields
54
+ def self.optionals
55
+ []
56
+ end
57
+
58
+ # An array for nullable fields
59
+ def self.nullables
60
+ []
61
+ end
62
+
63
+ def initialize(event_day_property:, dimensions:, default_unit_amount:,
64
+ daily_allowance:, matrix_values:)
65
+ @event_day_property = event_day_property
66
+ @dimensions = dimensions
67
+ @default_unit_amount = default_unit_amount
68
+ @daily_allowance = daily_allowance
69
+ @matrix_values = matrix_values
70
+ end
71
+
72
+ # Creates an instance of the object from a hash.
73
+ def self.from_hash(hash)
74
+ return nil unless hash
75
+
76
+ # Extract variables from the hash.
77
+ event_day_property =
78
+ hash.key?('event_day_property') ? hash['event_day_property'] : nil
79
+ dimensions = hash.key?('dimensions') ? hash['dimensions'] : nil
80
+ default_unit_amount =
81
+ hash.key?('default_unit_amount') ? hash['default_unit_amount'] : nil
82
+ daily_allowance =
83
+ hash.key?('daily_allowance') ? hash['daily_allowance'] : nil
84
+ # Parameter is an array, so we need to iterate through it
85
+ matrix_values = nil
86
+ unless hash['matrix_values'].nil?
87
+ matrix_values = []
88
+ hash['matrix_values'].each do |structure|
89
+ matrix_values << (DailyCreditAllowanceMatrixValue.from_hash(structure) if structure)
90
+ end
91
+ end
92
+
93
+ matrix_values = nil unless hash.key?('matrix_values')
94
+
95
+ # Create object from extracted values.
96
+ DailyCreditAllowanceConfig.new(event_day_property: event_day_property,
97
+ dimensions: dimensions,
98
+ default_unit_amount: default_unit_amount,
99
+ daily_allowance: daily_allowance,
100
+ matrix_values: matrix_values)
101
+ end
102
+
103
+ # Provides a human-readable string representation of the object.
104
+ def to_s
105
+ class_name = self.class.name.split('::').last
106
+ "<#{class_name} event_day_property: #{@event_day_property}, dimensions: #{@dimensions},"\
107
+ " default_unit_amount: #{@default_unit_amount}, daily_allowance: #{@daily_allowance},"\
108
+ " matrix_values: #{@matrix_values}>"
109
+ end
110
+
111
+ # Provides a debugging-friendly string with detailed object information.
112
+ def inspect
113
+ class_name = self.class.name.split('::').last
114
+ "<#{class_name} event_day_property: #{@event_day_property.inspect}, dimensions:"\
115
+ " #{@dimensions.inspect}, default_unit_amount: #{@default_unit_amount.inspect},"\
116
+ " daily_allowance: #{@daily_allowance.inspect}, matrix_values: #{@matrix_values.inspect}>"
117
+ end
118
+ end
119
+ end
@@ -0,0 +1,150 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # Configuration for daily_credit_allowance pricing
8
+ class DailyCreditAllowanceConfig1 < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # Event property whose value identifies the day bucket the event belongs to
13
+ # (e.g. 'event_day' set to an ISO date string in the customer's timezone).
14
+ # The allowance resets per distinct value of this property.
15
+ # @return [String]
16
+ attr_accessor :event_day_property
17
+
18
+ # One or two event property values to evaluate matrix groups by
19
+ # @return [Array[String]]
20
+ attr_accessor :dimensions
21
+
22
+ # Default per-unit credit rate for any usage not bucketed into a specified
23
+ # matrix_value
24
+ # @return [String]
25
+ attr_accessor :default_unit_amount
26
+
27
+ # Credits granted per day. Lose-it-or-use-it; does not roll over.
28
+ # @return [String]
29
+ attr_accessor :daily_allowance
30
+
31
+ # Per-dimension credit rates
32
+ # @return [Array[DailyCreditAllowanceMatrixValue]]
33
+ attr_accessor :matrix_values
34
+
35
+ # A mapping from model property names to API property names.
36
+ def self.names
37
+ @_hash = {} if @_hash.nil?
38
+ @_hash['event_day_property'] = 'event_day_property'
39
+ @_hash['dimensions'] = 'dimensions'
40
+ @_hash['default_unit_amount'] = 'default_unit_amount'
41
+ @_hash['daily_allowance'] = 'daily_allowance'
42
+ @_hash['matrix_values'] = 'matrix_values'
43
+ @_hash
44
+ end
45
+
46
+ # An array for optional fields
47
+ def self.optionals
48
+ []
49
+ end
50
+
51
+ # An array for nullable fields
52
+ def self.nullables
53
+ []
54
+ end
55
+
56
+ def initialize(event_day_property:, dimensions:, default_unit_amount:,
57
+ daily_allowance:, matrix_values:)
58
+ @event_day_property = event_day_property
59
+ @dimensions = dimensions
60
+ @default_unit_amount = default_unit_amount
61
+ @daily_allowance = daily_allowance
62
+ @matrix_values = matrix_values
63
+ end
64
+
65
+ # Creates an instance of the object from a hash.
66
+ def self.from_hash(hash)
67
+ return nil unless hash
68
+
69
+ # Extract variables from the hash.
70
+ event_day_property =
71
+ hash.key?('event_day_property') ? hash['event_day_property'] : nil
72
+ dimensions = hash.key?('dimensions') ? hash['dimensions'] : nil
73
+ default_unit_amount =
74
+ hash.key?('default_unit_amount') ? hash['default_unit_amount'] : nil
75
+ daily_allowance =
76
+ hash.key?('daily_allowance') ? hash['daily_allowance'] : nil
77
+ # Parameter is an array, so we need to iterate through it
78
+ matrix_values = nil
79
+ unless hash['matrix_values'].nil?
80
+ matrix_values = []
81
+ hash['matrix_values'].each do |structure|
82
+ matrix_values << (DailyCreditAllowanceMatrixValue.from_hash(structure) if structure)
83
+ end
84
+ end
85
+
86
+ matrix_values = nil unless hash.key?('matrix_values')
87
+
88
+ # Create object from extracted values.
89
+ DailyCreditAllowanceConfig1.new(event_day_property: event_day_property,
90
+ dimensions: dimensions,
91
+ default_unit_amount: default_unit_amount,
92
+ daily_allowance: daily_allowance,
93
+ matrix_values: matrix_values)
94
+ end
95
+
96
+ # Validates an instance of the object from a given value.
97
+ # @param [DailyCreditAllowanceConfig1 | Hash] The value against the validation is performed.
98
+ def self.validate(value)
99
+ if value.instance_of? self
100
+ return (
101
+ APIHelper.valid_type?(value.event_day_property,
102
+ ->(val) { val.instance_of? String }) and
103
+ APIHelper.valid_type?(value.dimensions,
104
+ ->(val) { val.instance_of? String }) and
105
+ APIHelper.valid_type?(value.default_unit_amount,
106
+ ->(val) { val.instance_of? String }) and
107
+ APIHelper.valid_type?(value.daily_allowance,
108
+ ->(val) { val.instance_of? String }) and
109
+ APIHelper.valid_type?(value.matrix_values,
110
+ ->(val) { DailyCreditAllowanceMatrixValue.validate(val) },
111
+ is_model_hash: true,
112
+ is_inner_model_hash: true)
113
+ )
114
+ end
115
+
116
+ return false unless value.instance_of? Hash
117
+
118
+ (
119
+ APIHelper.valid_type?(value['event_day_property'],
120
+ ->(val) { val.instance_of? String }) and
121
+ APIHelper.valid_type?(value['dimensions'],
122
+ ->(val) { val.instance_of? String }) and
123
+ APIHelper.valid_type?(value['default_unit_amount'],
124
+ ->(val) { val.instance_of? String }) and
125
+ APIHelper.valid_type?(value['daily_allowance'],
126
+ ->(val) { val.instance_of? String }) and
127
+ APIHelper.valid_type?(value['matrix_values'],
128
+ ->(val) { DailyCreditAllowanceMatrixValue.validate(val) },
129
+ is_model_hash: true,
130
+ is_inner_model_hash: true)
131
+ )
132
+ end
133
+
134
+ # Provides a human-readable string representation of the object.
135
+ def to_s
136
+ class_name = self.class.name.split('::').last
137
+ "<#{class_name} event_day_property: #{@event_day_property}, dimensions: #{@dimensions},"\
138
+ " default_unit_amount: #{@default_unit_amount}, daily_allowance: #{@daily_allowance},"\
139
+ " matrix_values: #{@matrix_values}>"
140
+ end
141
+
142
+ # Provides a debugging-friendly string with detailed object information.
143
+ def inspect
144
+ class_name = self.class.name.split('::').last
145
+ "<#{class_name} event_day_property: #{@event_day_property.inspect}, dimensions:"\
146
+ " #{@dimensions.inspect}, default_unit_amount: #{@default_unit_amount.inspect},"\
147
+ " daily_allowance: #{@daily_allowance.inspect}, matrix_values: #{@matrix_values.inspect}>"
148
+ end
149
+ end
150
+ end
@@ -0,0 +1,93 @@
1
+ # api_reference
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module ApiReference
7
+ # Per-dimension credit price for the daily credit allowance model.
8
+ class DailyCreditAllowanceMatrixValue < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # Credits charged per unit of usage matching the specified dimension_values
13
+ # @return [String]
14
+ attr_accessor :unit_amount
15
+
16
+ # One or two matrix keys to filter usage to this value by. For example,
17
+ # ["model"] could be used to apply a different credit rate to each AI model.
18
+ # @return [Array[String]]
19
+ attr_accessor :dimension_values
20
+
21
+ # A mapping from model property names to API property names.
22
+ def self.names
23
+ @_hash = {} if @_hash.nil?
24
+ @_hash['unit_amount'] = 'unit_amount'
25
+ @_hash['dimension_values'] = 'dimension_values'
26
+ @_hash
27
+ end
28
+
29
+ # An array for optional fields
30
+ def self.optionals
31
+ []
32
+ end
33
+
34
+ # An array for nullable fields
35
+ def self.nullables
36
+ []
37
+ end
38
+
39
+ def initialize(unit_amount:, dimension_values:)
40
+ @unit_amount = unit_amount
41
+ @dimension_values = dimension_values
42
+ end
43
+
44
+ # Creates an instance of the object from a hash.
45
+ def self.from_hash(hash)
46
+ return nil unless hash
47
+
48
+ # Extract variables from the hash.
49
+ unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil
50
+ dimension_values =
51
+ hash.key?('dimension_values') ? hash['dimension_values'] : nil
52
+
53
+ # Create object from extracted values.
54
+ DailyCreditAllowanceMatrixValue.new(unit_amount: unit_amount,
55
+ dimension_values: dimension_values)
56
+ end
57
+
58
+ # Validates an instance of the object from a given value.
59
+ # @param [DailyCreditAllowanceMatrixValue | Hash] The value against the validation is performed.
60
+ def self.validate(value)
61
+ if value.instance_of? self
62
+ return (
63
+ APIHelper.valid_type?(value.unit_amount,
64
+ ->(val) { val.instance_of? String }) and
65
+ APIHelper.valid_type?(value.dimension_values,
66
+ ->(val) { val.instance_of? String })
67
+ )
68
+ end
69
+
70
+ return false unless value.instance_of? Hash
71
+
72
+ (
73
+ APIHelper.valid_type?(value['unit_amount'],
74
+ ->(val) { val.instance_of? String }) and
75
+ APIHelper.valid_type?(value['dimension_values'],
76
+ ->(val) { val.instance_of? String })
77
+ )
78
+ end
79
+
80
+ # Provides a human-readable string representation of the object.
81
+ def to_s
82
+ class_name = self.class.name.split('::').last
83
+ "<#{class_name} unit_amount: #{@unit_amount}, dimension_values: #{@dimension_values}>"
84
+ end
85
+
86
+ # Provides a debugging-friendly string with detailed object information.
87
+ def inspect
88
+ class_name = self.class.name.split('::').last
89
+ "<#{class_name} unit_amount: #{@unit_amount.inspect}, dimension_values:"\
90
+ " #{@dimension_values.inspect}>"
91
+ end
92
+ end
93
+ end