orb-billing 1.35.0 → 1.36.0

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 (258) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -0
  3. data/README.md +1 -1
  4. data/lib/orb/client.rb +4 -0
  5. data/lib/orb/models/backfill_reflected_webhook_event.rb +180 -0
  6. data/lib/orb/models/backfill_reverted_webhook_event.rb +180 -0
  7. data/lib/orb/models/billable_metric_edited_webhook_event.rb +104 -0
  8. data/lib/orb/models/credit_block_accounting_sync_failed_webhook_event.rb +499 -0
  9. data/lib/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rb +494 -0
  10. data/lib/orb/models/credit_note_accounting_sync_failed_webhook_event.rb +161 -0
  11. data/lib/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rb +155 -0
  12. data/lib/orb/models/credit_note_issued_webhook_event.rb +65 -0
  13. data/lib/orb/models/credit_note_marked_as_void_webhook_event.rb +65 -0
  14. data/lib/orb/models/customer_accounting_sync_failed_webhook_event.rb +171 -0
  15. data/lib/orb/models/customer_accounting_sync_succeeded_webhook_event.rb +165 -0
  16. data/lib/orb/models/customer_balance_transaction_created_webhook_event.rb +212 -0
  17. data/lib/orb/models/customer_created_webhook_event.rb +81 -0
  18. data/lib/orb/models/customer_credit_balance_depleted_webhook_event.rb +560 -0
  19. data/lib/orb/models/customer_credit_balance_dropped_webhook_event.rb +566 -0
  20. data/lib/orb/models/customer_credit_balance_recovered_webhook_event.rb +560 -0
  21. data/lib/orb/models/customer_credit_ledger_incremented_webhook_event.rb +474 -0
  22. data/lib/orb/models/customer_edited_webhook_event.rb +344 -0
  23. data/lib/orb/models/data_exports_transfer_error_webhook_event.rb +100 -0
  24. data/lib/orb/models/data_exports_transfer_success_webhook_event.rb +94 -0
  25. data/lib/orb/models/event_unmatched_event_webhook_event.rb +105 -0
  26. data/lib/orb/models/ingestion_unmatched_customer_ids_webhook_event.rb +64 -0
  27. data/lib/orb/models/invoice_accounting_sync_failed_webhook_event.rb +164 -0
  28. data/lib/orb/models/invoice_accounting_sync_succeeded_webhook_event.rb +158 -0
  29. data/lib/orb/models/invoice_automation_schedule_step_executed_webhook_event.rb +338 -0
  30. data/lib/orb/models/invoice_cost_data_exported_webhook_event.rb +83 -0
  31. data/lib/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rb +70 -0
  32. data/lib/orb/models/invoice_due_date_recalculation_completed_webhook_event.rb +70 -0
  33. data/lib/orb/models/invoice_due_date_recalculation_started_webhook_event.rb +64 -0
  34. data/lib/orb/models/invoice_dunning_schedule_created_webhook_event.rb +186 -0
  35. data/lib/orb/models/invoice_dunning_schedule_ended_webhook_event.rb +180 -0
  36. data/lib/orb/models/invoice_dunning_schedule_reset_webhook_event.rb +184 -0
  37. data/lib/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rb +133 -0
  38. data/lib/orb/models/invoice_edited_webhook_event.rb +550 -0
  39. data/lib/orb/models/invoice_invoice_date_elapsed_webhook_event.rb +120 -0
  40. data/lib/orb/models/invoice_issue_failed_webhook_event.rb +79 -0
  41. data/lib/orb/models/invoice_issued_summary_webhook_event.rb +841 -0
  42. data/lib/orb/models/invoice_issued_webhook_event.rb +79 -0
  43. data/lib/orb/models/invoice_manually_marked_as_paid_webhook_event.rb +91 -0
  44. data/lib/orb/models/invoice_manually_marked_as_void_webhook_event.rb +68 -0
  45. data/lib/orb/models/invoice_payment_failed_webhook_event.rb +92 -0
  46. data/lib/orb/models/invoice_payment_processing_webhook_event.rb +85 -0
  47. data/lib/orb/models/invoice_payment_succeeded_webhook_event.rb +101 -0
  48. data/lib/orb/models/invoice_sync_failed_webhook_event.rb +85 -0
  49. data/lib/orb/models/invoice_sync_succeeded_webhook_event.rb +85 -0
  50. data/lib/orb/models/invoice_undo_mark_as_paid_webhook_event.rb +68 -0
  51. data/lib/orb/models/metric_events_dropped_by_watermark_webhook_event.rb +98 -0
  52. data/lib/orb/models/payment_method_created_webhook_event.rb +156 -0
  53. data/lib/orb/models/payment_method_deleted_webhook_event.rb +156 -0
  54. data/lib/orb/models/plan_default_version_set_webhook_event.rb +108 -0
  55. data/lib/orb/models/plan_version_created_webhook_event.rb +108 -0
  56. data/lib/orb/models/price_edited_webhook_event.rb +105 -0
  57. data/lib/orb/models/resource_event_test_webhook_event.rb +64 -0
  58. data/lib/orb/models/sales_order_accounting_sync_failed_webhook_event.rb +164 -0
  59. data/lib/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rb +158 -0
  60. data/lib/orb/models/subscription_accounting_sync_failed_webhook_event.rb +178 -0
  61. data/lib/orb/models/subscription_accounting_sync_succeeded_webhook_event.rb +172 -0
  62. data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +624 -0
  63. data/lib/orb/models/subscription_cancellation_scheduled_webhook_event.rb +93 -0
  64. data/lib/orb/models/subscription_cancellation_unscheduled_webhook_event.rb +93 -0
  65. data/lib/orb/models/subscription_cost_exceeded_webhook_event.rb +540 -0
  66. data/lib/orb/models/subscription_created_webhook_event.rb +82 -0
  67. data/lib/orb/models/subscription_edited_webhook_event.rb +134 -0
  68. data/lib/orb/models/subscription_ended_webhook_event.rb +82 -0
  69. data/lib/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rb +111 -0
  70. data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +655 -0
  71. data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +191 -0
  72. data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +214 -0
  73. data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +652 -0
  74. data/lib/orb/models/subscription_plan_change_scheduled_webhook_event.rb +105 -0
  75. data/lib/orb/models/subscription_plan_changed_webhook_event.rb +93 -0
  76. data/lib/orb/models/subscription_plan_version_change_scheduled_webhook_event.rb +106 -0
  77. data/lib/orb/models/subscription_plan_version_changed_webhook_event.rb +105 -0
  78. data/lib/orb/models/subscription_spend_exceeded_webhook_event.rb +541 -0
  79. data/lib/orb/models/subscription_started_webhook_event.rb +82 -0
  80. data/lib/orb/models/subscription_trial_ended_webhook_event.rb +82 -0
  81. data/lib/orb/models/subscription_usage_exceeded_webhook_event.rb +548 -0
  82. data/lib/orb/models/transaction_accounting_sync_failed_webhook_event.rb +236 -0
  83. data/lib/orb/models/transaction_accounting_sync_succeeded_webhook_event.rb +232 -0
  84. data/lib/orb/models/unwrap_webhook_event.rb +250 -0
  85. data/lib/orb/models/webhook_unwrap_params.rb +14 -0
  86. data/lib/orb/models.rb +180 -0
  87. data/lib/orb/resources/webhooks.rb +22 -0
  88. data/lib/orb/version.rb +1 -1
  89. data/lib/orb.rb +82 -0
  90. data/rbi/orb/client.rbi +3 -0
  91. data/rbi/orb/models/backfill_reflected_webhook_event.rbi +274 -0
  92. data/rbi/orb/models/backfill_reverted_webhook_event.rbi +271 -0
  93. data/rbi/orb/models/billable_metric_edited_webhook_event.rbi +198 -0
  94. data/rbi/orb/models/credit_block_accounting_sync_failed_webhook_event.rbi +1039 -0
  95. data/rbi/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbi +1034 -0
  96. data/rbi/orb/models/credit_note_accounting_sync_failed_webhook_event.rbi +315 -0
  97. data/rbi/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rbi +310 -0
  98. data/rbi/orb/models/credit_note_issued_webhook_event.rbi +98 -0
  99. data/rbi/orb/models/credit_note_marked_as_void_webhook_event.rbi +102 -0
  100. data/rbi/orb/models/customer_accounting_sync_failed_webhook_event.rbi +339 -0
  101. data/rbi/orb/models/customer_accounting_sync_succeeded_webhook_event.rbi +335 -0
  102. data/rbi/orb/models/customer_balance_transaction_created_webhook_event.rbi +437 -0
  103. data/rbi/orb/models/customer_created_webhook_event.rbi +128 -0
  104. data/rbi/orb/models/customer_credit_balance_depleted_webhook_event.rbi +1091 -0
  105. data/rbi/orb/models/customer_credit_balance_dropped_webhook_event.rbi +1096 -0
  106. data/rbi/orb/models/customer_credit_balance_recovered_webhook_event.rbi +1091 -0
  107. data/rbi/orb/models/customer_credit_ledger_incremented_webhook_event.rbi +987 -0
  108. data/rbi/orb/models/customer_edited_webhook_event.rbi +599 -0
  109. data/rbi/orb/models/data_exports_transfer_error_webhook_event.rbi +170 -0
  110. data/rbi/orb/models/data_exports_transfer_success_webhook_event.rbi +165 -0
  111. data/rbi/orb/models/event_unmatched_event_webhook_event.rbi +193 -0
  112. data/rbi/orb/models/ingestion_unmatched_customer_ids_webhook_event.rbi +132 -0
  113. data/rbi/orb/models/invoice_accounting_sync_failed_webhook_event.rbi +319 -0
  114. data/rbi/orb/models/invoice_accounting_sync_succeeded_webhook_event.rbi +312 -0
  115. data/rbi/orb/models/invoice_automation_schedule_step_executed_webhook_event.rbi +614 -0
  116. data/rbi/orb/models/invoice_cost_data_exported_webhook_event.rbi +144 -0
  117. data/rbi/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rbi +139 -0
  118. data/rbi/orb/models/invoice_due_date_recalculation_completed_webhook_event.rbi +139 -0
  119. data/rbi/orb/models/invoice_due_date_recalculation_started_webhook_event.rbi +132 -0
  120. data/rbi/orb/models/invoice_dunning_schedule_created_webhook_event.rbi +331 -0
  121. data/rbi/orb/models/invoice_dunning_schedule_ended_webhook_event.rbi +324 -0
  122. data/rbi/orb/models/invoice_dunning_schedule_reset_webhook_event.rbi +329 -0
  123. data/rbi/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rbi +250 -0
  124. data/rbi/orb/models/invoice_edited_webhook_event.rbi +942 -0
  125. data/rbi/orb/models/invoice_invoice_date_elapsed_webhook_event.rbi +251 -0
  126. data/rbi/orb/models/invoice_issue_failed_webhook_event.rbi +132 -0
  127. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +1432 -0
  128. data/rbi/orb/models/invoice_issued_webhook_event.rbi +134 -0
  129. data/rbi/orb/models/invoice_manually_marked_as_paid_webhook_event.rbi +165 -0
  130. data/rbi/orb/models/invoice_manually_marked_as_void_webhook_event.rbi +114 -0
  131. data/rbi/orb/models/invoice_payment_failed_webhook_event.rbi +157 -0
  132. data/rbi/orb/models/invoice_payment_processing_webhook_event.rbi +156 -0
  133. data/rbi/orb/models/invoice_payment_succeeded_webhook_event.rbi +175 -0
  134. data/rbi/orb/models/invoice_sync_failed_webhook_event.rbi +147 -0
  135. data/rbi/orb/models/invoice_sync_succeeded_webhook_event.rbi +147 -0
  136. data/rbi/orb/models/invoice_undo_mark_as_paid_webhook_event.rbi +106 -0
  137. data/rbi/orb/models/metric_events_dropped_by_watermark_webhook_event.rbi +167 -0
  138. data/rbi/orb/models/payment_method_created_webhook_event.rbi +259 -0
  139. data/rbi/orb/models/payment_method_deleted_webhook_event.rbi +259 -0
  140. data/rbi/orb/models/plan_default_version_set_webhook_event.rbi +196 -0
  141. data/rbi/orb/models/plan_version_created_webhook_event.rbi +190 -0
  142. data/rbi/orb/models/price_edited_webhook_event.rbi +235 -0
  143. data/rbi/orb/models/resource_event_test_webhook_event.rbi +116 -0
  144. data/rbi/orb/models/sales_order_accounting_sync_failed_webhook_event.rbi +321 -0
  145. data/rbi/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rbi +316 -0
  146. data/rbi/orb/models/subscription_accounting_sync_failed_webhook_event.rbi +353 -0
  147. data/rbi/orb/models/subscription_accounting_sync_succeeded_webhook_event.rbi +346 -0
  148. data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +1232 -0
  149. data/rbi/orb/models/subscription_cancellation_scheduled_webhook_event.rbi +179 -0
  150. data/rbi/orb/models/subscription_cancellation_unscheduled_webhook_event.rbi +183 -0
  151. data/rbi/orb/models/subscription_cost_exceeded_webhook_event.rbi +1034 -0
  152. data/rbi/orb/models/subscription_created_webhook_event.rbi +132 -0
  153. data/rbi/orb/models/subscription_edited_webhook_event.rbi +247 -0
  154. data/rbi/orb/models/subscription_ended_webhook_event.rbi +132 -0
  155. data/rbi/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rbi +206 -0
  156. data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +1262 -0
  157. data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +374 -0
  158. data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +421 -0
  159. data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +1265 -0
  160. data/rbi/orb/models/subscription_plan_change_scheduled_webhook_event.rbi +198 -0
  161. data/rbi/orb/models/subscription_plan_changed_webhook_event.rbi +169 -0
  162. data/rbi/orb/models/subscription_plan_version_change_scheduled_webhook_event.rbi +205 -0
  163. data/rbi/orb/models/subscription_plan_version_changed_webhook_event.rbi +199 -0
  164. data/rbi/orb/models/subscription_spend_exceeded_webhook_event.rbi +1035 -0
  165. data/rbi/orb/models/subscription_started_webhook_event.rbi +132 -0
  166. data/rbi/orb/models/subscription_trial_ended_webhook_event.rbi +136 -0
  167. data/rbi/orb/models/subscription_usage_exceeded_webhook_event.rbi +1041 -0
  168. data/rbi/orb/models/transaction_accounting_sync_failed_webhook_event.rbi +455 -0
  169. data/rbi/orb/models/transaction_accounting_sync_succeeded_webhook_event.rbi +449 -0
  170. data/rbi/orb/models/unwrap_webhook_event.rbi +99 -0
  171. data/rbi/orb/models/webhook_unwrap_params.rbi +25 -0
  172. data/rbi/orb/models.rbi +224 -0
  173. data/rbi/orb/resources/webhooks.rbi +103 -0
  174. data/sig/orb/client.rbs +2 -0
  175. data/sig/orb/models/backfill_reflected_webhook_event.rbs +130 -0
  176. data/sig/orb/models/backfill_reverted_webhook_event.rbs +130 -0
  177. data/sig/orb/models/billable_metric_edited_webhook_event.rbs +94 -0
  178. data/sig/orb/models/credit_block_accounting_sync_failed_webhook_event.rbs +412 -0
  179. data/sig/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbs +407 -0
  180. data/sig/orb/models/credit_note_accounting_sync_failed_webhook_event.rbs +147 -0
  181. data/sig/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rbs +142 -0
  182. data/sig/orb/models/credit_note_issued_webhook_event.rbs +50 -0
  183. data/sig/orb/models/credit_note_marked_as_void_webhook_event.rbs +50 -0
  184. data/sig/orb/models/customer_accounting_sync_failed_webhook_event.rbs +142 -0
  185. data/sig/orb/models/customer_accounting_sync_succeeded_webhook_event.rbs +137 -0
  186. data/sig/orb/models/customer_balance_transaction_created_webhook_event.rbs +171 -0
  187. data/sig/orb/models/customer_created_webhook_event.rbs +50 -0
  188. data/sig/orb/models/customer_credit_balance_depleted_webhook_event.rbs +374 -0
  189. data/sig/orb/models/customer_credit_balance_dropped_webhook_event.rbs +379 -0
  190. data/sig/orb/models/customer_credit_balance_recovered_webhook_event.rbs +374 -0
  191. data/sig/orb/models/customer_credit_ledger_incremented_webhook_event.rbs +364 -0
  192. data/sig/orb/models/customer_edited_webhook_event.rbs +139 -0
  193. data/sig/orb/models/data_exports_transfer_error_webhook_event.rbs +92 -0
  194. data/sig/orb/models/data_exports_transfer_success_webhook_event.rbs +87 -0
  195. data/sig/orb/models/event_unmatched_event_webhook_event.rbs +102 -0
  196. data/sig/orb/models/ingestion_unmatched_customer_ids_webhook_event.rbs +55 -0
  197. data/sig/orb/models/invoice_accounting_sync_failed_webhook_event.rbs +147 -0
  198. data/sig/orb/models/invoice_accounting_sync_succeeded_webhook_event.rbs +142 -0
  199. data/sig/orb/models/invoice_automation_schedule_step_executed_webhook_event.rbs +313 -0
  200. data/sig/orb/models/invoice_cost_data_exported_webhook_event.rbs +73 -0
  201. data/sig/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rbs +57 -0
  202. data/sig/orb/models/invoice_due_date_recalculation_completed_webhook_event.rbs +57 -0
  203. data/sig/orb/models/invoice_due_date_recalculation_started_webhook_event.rbs +55 -0
  204. data/sig/orb/models/invoice_dunning_schedule_created_webhook_event.rbs +171 -0
  205. data/sig/orb/models/invoice_dunning_schedule_ended_webhook_event.rbs +166 -0
  206. data/sig/orb/models/invoice_dunning_schedule_reset_webhook_event.rbs +156 -0
  207. data/sig/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rbs +119 -0
  208. data/sig/orb/models/invoice_edited_webhook_event.rbs +388 -0
  209. data/sig/orb/models/invoice_invoice_date_elapsed_webhook_event.rbs +111 -0
  210. data/sig/orb/models/invoice_issue_failed_webhook_event.rbs +60 -0
  211. data/sig/orb/models/invoice_issued_summary_webhook_event.rbs +504 -0
  212. data/sig/orb/models/invoice_issued_webhook_event.rbs +60 -0
  213. data/sig/orb/models/invoice_manually_marked_as_paid_webhook_event.rbs +73 -0
  214. data/sig/orb/models/invoice_manually_marked_as_void_webhook_event.rbs +50 -0
  215. data/sig/orb/models/invoice_payment_failed_webhook_event.rbs +77 -0
  216. data/sig/orb/models/invoice_payment_processing_webhook_event.rbs +71 -0
  217. data/sig/orb/models/invoice_payment_succeeded_webhook_event.rbs +82 -0
  218. data/sig/orb/models/invoice_sync_failed_webhook_event.rbs +69 -0
  219. data/sig/orb/models/invoice_sync_succeeded_webhook_event.rbs +69 -0
  220. data/sig/orb/models/invoice_undo_mark_as_paid_webhook_event.rbs +50 -0
  221. data/sig/orb/models/metric_events_dropped_by_watermark_webhook_event.rbs +82 -0
  222. data/sig/orb/models/payment_method_created_webhook_event.rbs +112 -0
  223. data/sig/orb/models/payment_method_deleted_webhook_event.rbs +112 -0
  224. data/sig/orb/models/plan_default_version_set_webhook_event.rbs +94 -0
  225. data/sig/orb/models/plan_version_created_webhook_event.rbs +91 -0
  226. data/sig/orb/models/price_edited_webhook_event.rbs +77 -0
  227. data/sig/orb/models/resource_event_test_webhook_event.rbs +57 -0
  228. data/sig/orb/models/sales_order_accounting_sync_failed_webhook_event.rbs +147 -0
  229. data/sig/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rbs +142 -0
  230. data/sig/orb/models/subscription_accounting_sync_failed_webhook_event.rbs +147 -0
  231. data/sig/orb/models/subscription_accounting_sync_succeeded_webhook_event.rbs +142 -0
  232. data/sig/orb/models/subscription_alert_disabled_webhook_event.rbs +444 -0
  233. data/sig/orb/models/subscription_cancellation_scheduled_webhook_event.rbs +60 -0
  234. data/sig/orb/models/subscription_cancellation_unscheduled_webhook_event.rbs +60 -0
  235. data/sig/orb/models/subscription_cost_exceeded_webhook_event.rbs +362 -0
  236. data/sig/orb/models/subscription_created_webhook_event.rbs +50 -0
  237. data/sig/orb/models/subscription_edited_webhook_event.rbs +109 -0
  238. data/sig/orb/models/subscription_ended_webhook_event.rbs +50 -0
  239. data/sig/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rbs +82 -0
  240. data/sig/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbs +465 -0
  241. data/sig/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbs +158 -0
  242. data/sig/orb/models/subscription_license_allocation_reset_webhook_event.rbs +180 -0
  243. data/sig/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbs +460 -0
  244. data/sig/orb/models/subscription_plan_change_scheduled_webhook_event.rbs +73 -0
  245. data/sig/orb/models/subscription_plan_changed_webhook_event.rbs +60 -0
  246. data/sig/orb/models/subscription_plan_version_change_scheduled_webhook_event.rbs +77 -0
  247. data/sig/orb/models/subscription_plan_version_changed_webhook_event.rbs +77 -0
  248. data/sig/orb/models/subscription_spend_exceeded_webhook_event.rbs +362 -0
  249. data/sig/orb/models/subscription_started_webhook_event.rbs +50 -0
  250. data/sig/orb/models/subscription_trial_ended_webhook_event.rbs +50 -0
  251. data/sig/orb/models/subscription_usage_exceeded_webhook_event.rbs +367 -0
  252. data/sig/orb/models/transaction_accounting_sync_failed_webhook_event.rbs +205 -0
  253. data/sig/orb/models/transaction_accounting_sync_succeeded_webhook_event.rbs +200 -0
  254. data/sig/orb/models/unwrap_webhook_event.rbs +90 -0
  255. data/sig/orb/models/webhook_unwrap_params.rbs +14 -0
  256. data/sig/orb/models.rbs +162 -0
  257. data/sig/orb/resources/webhooks.rbs +89 -0
  258. metadata +247 -1
@@ -0,0 +1,494 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ class CreditBlockAccountingSyncSucceededWebhookEvent < Orb::Internal::Type::BaseModel
6
+ # @!attribute id
7
+ # The ID of this webhook event.
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute accounting_sync_record
13
+ #
14
+ # @return [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::AccountingSyncRecord]
15
+ required :accounting_sync_record,
16
+ -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::AccountingSyncRecord }
17
+
18
+ # @!attribute block
19
+ # The Credit Block resource models prepaid credits within Orb.
20
+ #
21
+ # @return [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block]
22
+ required :block, -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block }
23
+
24
+ # @!attribute created_at
25
+ # The time at which this event was created, to the second.
26
+ #
27
+ # @return [Time]
28
+ required :created_at, Time
29
+
30
+ # @!attribute properties
31
+ #
32
+ # @return [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Properties]
33
+ required :properties, -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Properties }
34
+
35
+ # @!attribute type
36
+ # The event this payload describes.
37
+ #
38
+ # @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Type]
39
+ required :type, enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Type }
40
+
41
+ # @!method initialize(id:, accounting_sync_record:, block:, created_at:, properties:, type:)
42
+ # Issued when a credit block accounting sync succeeds.
43
+ #
44
+ # @param id [String] The ID of this webhook event.
45
+ #
46
+ # @param accounting_sync_record [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::AccountingSyncRecord]
47
+ #
48
+ # @param block [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block] The Credit Block resource models prepaid credits within Orb.
49
+ #
50
+ # @param created_at [Time] The time at which this event was created, to the second.
51
+ #
52
+ # @param properties [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Properties]
53
+ #
54
+ # @param type [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Type] The event this payload describes.
55
+
56
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent#accounting_sync_record
57
+ class AccountingSyncRecord < Orb::Internal::Type::BaseModel
58
+ # @!attribute id
59
+ #
60
+ # @return [String]
61
+ required :id, String
62
+
63
+ # @!attribute customer_id
64
+ #
65
+ # @return [String]
66
+ required :customer_id, String
67
+
68
+ # @!attribute record_type
69
+ #
70
+ # @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType]
71
+ required :record_type,
72
+ enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType }
73
+
74
+ # @!attribute block_id
75
+ #
76
+ # @return [String, nil]
77
+ optional :block_id, String, nil?: true
78
+
79
+ # @!attribute error_details
80
+ #
81
+ # @return [Hash{Symbol=>Object}, nil]
82
+ optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
83
+
84
+ # @!attribute invoice_id
85
+ #
86
+ # @return [String, nil]
87
+ optional :invoice_id, String, nil?: true
88
+
89
+ # @!attribute provider_customer_id
90
+ #
91
+ # @return [String, nil]
92
+ optional :provider_customer_id, String, nil?: true
93
+
94
+ # @!attribute status
95
+ #
96
+ # @return [String, nil]
97
+ optional :status, String, nil?: true
98
+
99
+ # @!attribute sync_action
100
+ #
101
+ # @return [String, nil]
102
+ optional :sync_action, String, nil?: true
103
+
104
+ # @!method initialize(id:, customer_id:, record_type:, block_id: nil, error_details: nil, invoice_id: nil, provider_customer_id: nil, status: nil, sync_action: nil)
105
+ # @param id [String]
106
+ # @param customer_id [String]
107
+ # @param record_type [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType]
108
+ # @param block_id [String, nil]
109
+ # @param error_details [Hash{Symbol=>Object}, nil]
110
+ # @param invoice_id [String, nil]
111
+ # @param provider_customer_id [String, nil]
112
+ # @param status [String, nil]
113
+ # @param sync_action [String, nil]
114
+
115
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::AccountingSyncRecord#record_type
116
+ module RecordType
117
+ extend Orb::Internal::Type::Enum
118
+
119
+ CUSTOMER = :customer
120
+ INVOICE = :invoice
121
+ TRANSACTION = :transaction
122
+ CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
123
+ CREDIT_NOTE = :credit_note
124
+ SUBSCRIPTION = :subscription
125
+ SALES_ORDER = :sales_order
126
+ BLOCK = :block
127
+
128
+ # @!method self.values
129
+ # @return [Array<Symbol>]
130
+ end
131
+ end
132
+
133
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent#block
134
+ class Block < Orb::Internal::Type::BaseModel
135
+ # @!attribute id
136
+ #
137
+ # @return [String]
138
+ required :id, String
139
+
140
+ # @!attribute balance
141
+ #
142
+ # @return [String]
143
+ required :balance, String
144
+
145
+ # @!attribute credit_block_source
146
+ # How this credit block was created: `allocation` (a subscription's recurring
147
+ # credit allocation), `top_up` (an automatic balance-threshold top-up),
148
+ # `commitment` (a subscription commitment true-up rolled forward as credit), or
149
+ # `manual` (a manual credit ledger increment, including credits voided or expired
150
+ # off another block).
151
+ #
152
+ # @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditBlockSource]
153
+ required :credit_block_source,
154
+ enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditBlockSource }
155
+
156
+ # @!attribute effective_date
157
+ #
158
+ # @return [Time, nil]
159
+ required :effective_date, Time, nil?: true
160
+
161
+ # @!attribute expiry_date
162
+ #
163
+ # @return [Time, nil]
164
+ required :expiry_date, Time, nil?: true
165
+
166
+ # @!attribute filters
167
+ #
168
+ # @return [Array<Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter>]
169
+ required :filters,
170
+ -> { Orb::Internal::Type::ArrayOf[Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter] }
171
+
172
+ # @!attribute maximum_initial_balance
173
+ #
174
+ # @return [String, nil]
175
+ required :maximum_initial_balance, String, nil?: true
176
+
177
+ # @!attribute metadata
178
+ # User specified key-value pairs for the resource. If not present, this defaults
179
+ # to an empty dictionary. Individual keys can be removed by setting the value to
180
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
181
+ # `null`.
182
+ #
183
+ # @return [Hash{Symbol=>String}]
184
+ required :metadata, Orb::Internal::Type::HashOf[String]
185
+
186
+ # @!attribute per_unit_cost_basis
187
+ #
188
+ # @return [String, nil]
189
+ required :per_unit_cost_basis, String, nil?: true
190
+
191
+ # @!attribute status
192
+ #
193
+ # @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Status]
194
+ required :status, enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Status }
195
+
196
+ # @!attribute credit_allocation
197
+ # The credit allocation that funded a block. Extends the allocation resource
198
+ # serialized on prices with the catalog-item attribution of the funding price.
199
+ #
200
+ # @return [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation, nil]
201
+ optional :credit_allocation,
202
+ -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation },
203
+ nil?: true
204
+
205
+ # @!attribute credit_commitment
206
+ # The subscription commitment whose true-up rolled forward into this credit block.
207
+ # Present only when `credit_block_source` is `commitment`.
208
+ #
209
+ # @return [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditCommitment, nil]
210
+ optional :credit_commitment,
211
+ -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditCommitment },
212
+ nil?: true
213
+
214
+ # @!method initialize(id:, balance:, credit_block_source:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:, credit_allocation: nil, credit_commitment: nil)
215
+ # Some parameter documentations has been truncated, see
216
+ # {Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block} for more
217
+ # details.
218
+ #
219
+ # The Credit Block resource models prepaid credits within Orb.
220
+ #
221
+ # @param id [String]
222
+ #
223
+ # @param balance [String]
224
+ #
225
+ # @param credit_block_source [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditBlockSource] How this credit block was created: `allocation` (a subscription's recurring cred
226
+ #
227
+ # @param effective_date [Time, nil]
228
+ #
229
+ # @param expiry_date [Time, nil]
230
+ #
231
+ # @param filters [Array<Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter>]
232
+ #
233
+ # @param maximum_initial_balance [String, nil]
234
+ #
235
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
236
+ #
237
+ # @param per_unit_cost_basis [String, nil]
238
+ #
239
+ # @param status [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Status]
240
+ #
241
+ # @param credit_allocation [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
242
+ #
243
+ # @param credit_commitment [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditCommitment, nil] The subscription commitment whose true-up rolled forward into this credit block.
244
+
245
+ # How this credit block was created: `allocation` (a subscription's recurring
246
+ # credit allocation), `top_up` (an automatic balance-threshold top-up),
247
+ # `commitment` (a subscription commitment true-up rolled forward as credit), or
248
+ # `manual` (a manual credit ledger increment, including credits voided or expired
249
+ # off another block).
250
+ #
251
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block#credit_block_source
252
+ module CreditBlockSource
253
+ extend Orb::Internal::Type::Enum
254
+
255
+ ALLOCATION = :allocation
256
+ TOP_UP = :top_up
257
+ COMMITMENT = :commitment
258
+ MANUAL = :manual
259
+
260
+ # @!method self.values
261
+ # @return [Array<Symbol>]
262
+ end
263
+
264
+ class Filter < Orb::Internal::Type::BaseModel
265
+ # @!attribute field
266
+ # The property of the price to filter on.
267
+ #
268
+ # @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter::Field]
269
+ required :field, enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter::Field }
270
+
271
+ # @!attribute operator
272
+ # Should prices that match the filter be included or excluded.
273
+ #
274
+ # @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter::Operator]
275
+ required :operator,
276
+ enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter::Operator }
277
+
278
+ # @!attribute values
279
+ # The IDs or values that match this filter.
280
+ #
281
+ # @return [Array<String>]
282
+ required :values, Orb::Internal::Type::ArrayOf[String]
283
+
284
+ # @!method initialize(field:, operator:, values:)
285
+ # @param field [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter::Field] The property of the price to filter on.
286
+ #
287
+ # @param operator [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter::Operator] Should prices that match the filter be included or excluded.
288
+ #
289
+ # @param values [Array<String>] The IDs or values that match this filter.
290
+
291
+ # The property of the price to filter on.
292
+ #
293
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter#field
294
+ module Field
295
+ extend Orb::Internal::Type::Enum
296
+
297
+ PRICE_ID = :price_id
298
+ ITEM_ID = :item_id
299
+ PRICE_TYPE = :price_type
300
+ CURRENCY = :currency
301
+ PRICING_UNIT_ID = :pricing_unit_id
302
+
303
+ # @!method self.values
304
+ # @return [Array<Symbol>]
305
+ end
306
+
307
+ # Should prices that match the filter be included or excluded.
308
+ #
309
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::Filter#operator
310
+ module Operator
311
+ extend Orb::Internal::Type::Enum
312
+
313
+ INCLUDES = :includes
314
+ EXCLUDES = :excludes
315
+
316
+ # @!method self.values
317
+ # @return [Array<Symbol>]
318
+ end
319
+ end
320
+
321
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block#status
322
+ module Status
323
+ extend Orb::Internal::Type::Enum
324
+
325
+ ACTIVE = :active
326
+ PENDING_PAYMENT = :pending_payment
327
+
328
+ # @!method self.values
329
+ # @return [Array<Symbol>]
330
+ end
331
+
332
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block#credit_allocation
333
+ class CreditAllocation < Orb::Internal::Type::BaseModel
334
+ # @!attribute allows_rollover
335
+ #
336
+ # @return [Boolean]
337
+ required :allows_rollover, Orb::Internal::Type::Boolean
338
+
339
+ # @!attribute currency
340
+ #
341
+ # @return [String]
342
+ required :currency, String
343
+
344
+ # @!attribute custom_expiration
345
+ #
346
+ # @return [Orb::Models::CustomExpiration, nil]
347
+ required :custom_expiration, -> { Orb::CustomExpiration }, nil?: true
348
+
349
+ # @!attribute item_id
350
+ # The ID of the catalog item this block was allocated from, derived from the
351
+ # allocation's price.
352
+ #
353
+ # @return [String]
354
+ required :item_id, String
355
+
356
+ # @!attribute filters
357
+ #
358
+ # @return [Array<Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter>, nil]
359
+ optional :filters,
360
+ -> { Orb::Internal::Type::ArrayOf[Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter] }
361
+
362
+ # @!attribute license_type_id
363
+ #
364
+ # @return [String, nil]
365
+ optional :license_type_id, String, nil?: true
366
+
367
+ # @!method initialize(allows_rollover:, currency:, custom_expiration:, item_id:, filters: nil, license_type_id: nil)
368
+ # Some parameter documentations has been truncated, see
369
+ # {Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation}
370
+ # for more details.
371
+ #
372
+ # The credit allocation that funded a block. Extends the allocation resource
373
+ # serialized on prices with the catalog-item attribution of the funding price.
374
+ #
375
+ # @param allows_rollover [Boolean]
376
+ #
377
+ # @param currency [String]
378
+ #
379
+ # @param custom_expiration [Orb::Models::CustomExpiration, nil]
380
+ #
381
+ # @param item_id [String] The ID of the catalog item this block was allocated from, derived from the alloc
382
+ #
383
+ # @param filters [Array<Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter>]
384
+ #
385
+ # @param license_type_id [String, nil]
386
+
387
+ class Filter < Orb::Internal::Type::BaseModel
388
+ # @!attribute field
389
+ # The property of the price to filter on.
390
+ #
391
+ # @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter::Field]
392
+ required :field,
393
+ enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter::Field }
394
+
395
+ # @!attribute operator
396
+ # Should prices that match the filter be included or excluded.
397
+ #
398
+ # @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter::Operator]
399
+ required :operator,
400
+ enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter::Operator }
401
+
402
+ # @!attribute values
403
+ # The IDs or values that match this filter.
404
+ #
405
+ # @return [Array<String>]
406
+ required :values, Orb::Internal::Type::ArrayOf[String]
407
+
408
+ # @!method initialize(field:, operator:, values:)
409
+ # @param field [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter::Field] The property of the price to filter on.
410
+ #
411
+ # @param operator [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter::Operator] Should prices that match the filter be included or excluded.
412
+ #
413
+ # @param values [Array<String>] The IDs or values that match this filter.
414
+
415
+ # The property of the price to filter on.
416
+ #
417
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter#field
418
+ module Field
419
+ extend Orb::Internal::Type::Enum
420
+
421
+ PRICE_ID = :price_id
422
+ ITEM_ID = :item_id
423
+ PRICE_TYPE = :price_type
424
+ CURRENCY = :currency
425
+ PRICING_UNIT_ID = :pricing_unit_id
426
+
427
+ # @!method self.values
428
+ # @return [Array<Symbol>]
429
+ end
430
+
431
+ # Should prices that match the filter be included or excluded.
432
+ #
433
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block::CreditAllocation::Filter#operator
434
+ module Operator
435
+ extend Orb::Internal::Type::Enum
436
+
437
+ INCLUDES = :includes
438
+ EXCLUDES = :excludes
439
+
440
+ # @!method self.values
441
+ # @return [Array<Symbol>]
442
+ end
443
+ end
444
+ end
445
+
446
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Block#credit_commitment
447
+ class CreditCommitment < Orb::Internal::Type::BaseModel
448
+ # @!attribute id
449
+ # The ID of the subscription commitment this block was rolled forward from.
450
+ #
451
+ # @return [String]
452
+ required :id, String
453
+
454
+ # @!attribute subscription_id
455
+ # The subscription the commitment belongs to.
456
+ #
457
+ # @return [String, nil]
458
+ optional :subscription_id, String, nil?: true
459
+
460
+ # @!method initialize(id:, subscription_id: nil)
461
+ # The subscription commitment whose true-up rolled forward into this credit block.
462
+ # Present only when `credit_block_source` is `commitment`.
463
+ #
464
+ # @param id [String] The ID of the subscription commitment this block was rolled forward from.
465
+ #
466
+ # @param subscription_id [String, nil] The subscription the commitment belongs to.
467
+ end
468
+ end
469
+
470
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent#properties
471
+ class Properties < Orb::Internal::Type::BaseModel
472
+ # @!attribute connection_type
473
+ #
474
+ # @return [String]
475
+ required :connection_type, String
476
+
477
+ # @!method initialize(connection_type:)
478
+ # @param connection_type [String]
479
+ end
480
+
481
+ # The event this payload describes.
482
+ #
483
+ # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent#type
484
+ module Type
485
+ extend Orb::Internal::Type::Enum
486
+
487
+ CREDIT_BLOCK_ACCOUNTING_SYNC_SUCCEEDED = :"credit_block.accounting_sync_succeeded"
488
+
489
+ # @!method self.values
490
+ # @return [Array<Symbol>]
491
+ end
492
+ end
493
+ end
494
+ end
@@ -0,0 +1,161 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ class CreditNoteAccountingSyncFailedWebhookEvent < Orb::Internal::Type::BaseModel
6
+ # @!attribute id
7
+ # The ID of this webhook event.
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute accounting_sync_record
13
+ #
14
+ # @return [Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
15
+ required :accounting_sync_record,
16
+ -> { Orb::CreditNoteAccountingSyncFailedWebhookEvent::AccountingSyncRecord }
17
+
18
+ # @!attribute created_at
19
+ # The time at which this event was created, to the second.
20
+ #
21
+ # @return [Time]
22
+ required :created_at, Time
23
+
24
+ # @!attribute credit_note
25
+ # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
26
+ # been applied to a particular invoice.
27
+ #
28
+ # @return [Orb::Models::CreditNote]
29
+ required :credit_note, -> { Orb::CreditNote }
30
+
31
+ # @!attribute properties
32
+ #
33
+ # @return [Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::Properties]
34
+ required :properties, -> { Orb::CreditNoteAccountingSyncFailedWebhookEvent::Properties }
35
+
36
+ # @!attribute type
37
+ # The event this payload describes.
38
+ #
39
+ # @return [Symbol, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::Type]
40
+ required :type, enum: -> { Orb::CreditNoteAccountingSyncFailedWebhookEvent::Type }
41
+
42
+ # @!method initialize(id:, accounting_sync_record:, created_at:, credit_note:, properties:, type:)
43
+ # Some parameter documentations has been truncated, see
44
+ # {Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent} for more details.
45
+ #
46
+ # Issued when a credit note accounting sync fails.
47
+ #
48
+ # @param id [String] The ID of this webhook event.
49
+ #
50
+ # @param accounting_sync_record [Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
51
+ #
52
+ # @param created_at [Time] The time at which this event was created, to the second.
53
+ #
54
+ # @param credit_note [Orb::Models::CreditNote] The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
55
+ #
56
+ # @param properties [Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::Properties]
57
+ #
58
+ # @param type [Symbol, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::Type] The event this payload describes.
59
+
60
+ # @see Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent#accounting_sync_record
61
+ class AccountingSyncRecord < Orb::Internal::Type::BaseModel
62
+ # @!attribute id
63
+ #
64
+ # @return [String]
65
+ required :id, String
66
+
67
+ # @!attribute customer_id
68
+ #
69
+ # @return [String]
70
+ required :customer_id, String
71
+
72
+ # @!attribute record_type
73
+ #
74
+ # @return [Symbol, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
75
+ required :record_type,
76
+ enum: -> { Orb::CreditNoteAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType }
77
+
78
+ # @!attribute credit_note_id
79
+ #
80
+ # @return [String, nil]
81
+ optional :credit_note_id, String, nil?: true
82
+
83
+ # @!attribute error_details
84
+ #
85
+ # @return [Hash{Symbol=>Object}, nil]
86
+ optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
87
+
88
+ # @!attribute provider_customer_id
89
+ #
90
+ # @return [String, nil]
91
+ optional :provider_customer_id, String, nil?: true
92
+
93
+ # @!attribute status
94
+ #
95
+ # @return [String, nil]
96
+ optional :status, String, nil?: true
97
+
98
+ # @!attribute sync_action
99
+ #
100
+ # @return [String, nil]
101
+ optional :sync_action, String, nil?: true
102
+
103
+ # @!method initialize(id:, customer_id:, record_type:, credit_note_id: nil, error_details: nil, provider_customer_id: nil, status: nil, sync_action: nil)
104
+ # @param id [String]
105
+ # @param customer_id [String]
106
+ # @param record_type [Symbol, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
107
+ # @param credit_note_id [String, nil]
108
+ # @param error_details [Hash{Symbol=>Object}, nil]
109
+ # @param provider_customer_id [String, nil]
110
+ # @param status [String, nil]
111
+ # @param sync_action [String, nil]
112
+
113
+ # @see Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::AccountingSyncRecord#record_type
114
+ module RecordType
115
+ extend Orb::Internal::Type::Enum
116
+
117
+ CUSTOMER = :customer
118
+ INVOICE = :invoice
119
+ TRANSACTION = :transaction
120
+ CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
121
+ CREDIT_NOTE = :credit_note
122
+ SUBSCRIPTION = :subscription
123
+ SALES_ORDER = :sales_order
124
+ BLOCK = :block
125
+
126
+ # @!method self.values
127
+ # @return [Array<Symbol>]
128
+ end
129
+ end
130
+
131
+ # @see Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent#properties
132
+ class Properties < Orb::Internal::Type::BaseModel
133
+ # @!attribute connection_type
134
+ #
135
+ # @return [String]
136
+ required :connection_type, String
137
+
138
+ # @!attribute failure_reason
139
+ #
140
+ # @return [String]
141
+ required :failure_reason, String
142
+
143
+ # @!method initialize(connection_type:, failure_reason:)
144
+ # @param connection_type [String]
145
+ # @param failure_reason [String]
146
+ end
147
+
148
+ # The event this payload describes.
149
+ #
150
+ # @see Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent#type
151
+ module Type
152
+ extend Orb::Internal::Type::Enum
153
+
154
+ CREDIT_NOTE_ACCOUNTING_SYNC_FAILED = :"credit_note.accounting_sync_failed"
155
+
156
+ # @!method self.values
157
+ # @return [Array<Symbol>]
158
+ end
159
+ end
160
+ end
161
+ end