orb-billing 1.35.0 → 1.37.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 +35 -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,344 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ class CustomerEditedWebhookEvent < 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 created_at
13
+ # The time at which this event was created, to the second.
14
+ #
15
+ # @return [Time]
16
+ required :created_at, Time
17
+
18
+ # @!attribute customer
19
+ # A customer is a buyer of your products, and the other party to the billing
20
+ # relationship.
21
+ #
22
+ # In Orb, customers are assigned system generated identifiers automatically, but
23
+ # it's often desirable to have these match existing identifiers in your system. To
24
+ # avoid having to denormalize Orb ID information, you can pass in an
25
+ # `external_customer_id` with your own identifier. See
26
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
27
+ # information about how these aliases work in Orb.
28
+ #
29
+ # In addition to having an identifier in your system, a customer may exist in a
30
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
31
+ # `payment_provider` enum field to express this mapping.
32
+ #
33
+ # A customer also has a timezone (from the standard
34
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
35
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
36
+ # information on what this timezone parameter influences within Orb.
37
+ #
38
+ # @return [Orb::Models::Customer]
39
+ required :customer, -> { Orb::Customer }
40
+
41
+ # @!attribute properties
42
+ #
43
+ # @return [Orb::Models::CustomerEditedWebhookEvent::Properties]
44
+ required :properties, -> { Orb::CustomerEditedWebhookEvent::Properties }
45
+
46
+ # @!attribute type
47
+ # The event this payload describes.
48
+ #
49
+ # @return [Symbol, Orb::Models::CustomerEditedWebhookEvent::Type]
50
+ required :type, enum: -> { Orb::CustomerEditedWebhookEvent::Type }
51
+
52
+ # @!method initialize(id:, created_at:, customer:, properties:, type:)
53
+ # Some parameter documentations has been truncated, see
54
+ # {Orb::Models::CustomerEditedWebhookEvent} for more details.
55
+ #
56
+ # Issued when a customer is updated.
57
+ #
58
+ # @param id [String] The ID of this webhook event.
59
+ #
60
+ # @param created_at [Time] The time at which this event was created, to the second.
61
+ #
62
+ # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
63
+ #
64
+ # @param properties [Orb::Models::CustomerEditedWebhookEvent::Properties]
65
+ #
66
+ # @param type [Symbol, Orb::Models::CustomerEditedWebhookEvent::Type] The event this payload describes.
67
+
68
+ # @see Orb::Models::CustomerEditedWebhookEvent#properties
69
+ class Properties < Orb::Internal::Type::BaseModel
70
+ # @!attribute previous_attributes
71
+ # metadata values are non-null on the wire (deleting a key removes it from
72
+ # storage); the Optional[str] values only exist on the new half of a metadata
73
+ # FieldChange.
74
+ #
75
+ # @return [Orb::Models::CustomerEditedWebhookEvent::Properties::PreviousAttributes]
76
+ required :previous_attributes, -> { Orb::CustomerEditedWebhookEvent::Properties::PreviousAttributes }
77
+
78
+ # @!method initialize(previous_attributes:)
79
+ # Some parameter documentations has been truncated, see
80
+ # {Orb::Models::CustomerEditedWebhookEvent::Properties} for more details.
81
+ #
82
+ # @param previous_attributes [Orb::Models::CustomerEditedWebhookEvent::Properties::PreviousAttributes] metadata values are non-null on the wire (deleting a key removes it from storage
83
+
84
+ # @see Orb::Models::CustomerEditedWebhookEvent::Properties#previous_attributes
85
+ class PreviousAttributes < Orb::Internal::Type::BaseModel
86
+ # @!attribute auto_collection
87
+ #
88
+ # @return [Boolean, nil]
89
+ optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
90
+
91
+ # @!attribute billing_address
92
+ #
93
+ # @return [Orb::Models::Address, nil]
94
+ optional :billing_address, -> { Orb::Address }, nil?: true
95
+
96
+ # @!attribute default_payment_method_id
97
+ #
98
+ # @return [String, nil]
99
+ optional :default_payment_method_id, String, nil?: true
100
+
101
+ # @!attribute email
102
+ #
103
+ # @return [String, nil]
104
+ optional :email, String, nil?: true
105
+
106
+ # @!attribute email_delivery
107
+ #
108
+ # @return [Boolean, nil]
109
+ optional :email_delivery, Orb::Internal::Type::Boolean, nil?: true
110
+
111
+ # @!attribute external_customer_id
112
+ #
113
+ # @return [String, nil]
114
+ optional :external_customer_id, String, nil?: true
115
+
116
+ # @!attribute metadata
117
+ #
118
+ # @return [Hash{Symbol=>String}, nil]
119
+ optional :metadata, Orb::Internal::Type::HashOf[String], nil?: true
120
+
121
+ # @!attribute name
122
+ #
123
+ # @return [String, nil]
124
+ optional :name, String, nil?: true
125
+
126
+ # @!attribute payment_provider
127
+ #
128
+ # @return [String, nil]
129
+ optional :payment_provider, String, nil?: true
130
+
131
+ # @!attribute payment_provider_id
132
+ #
133
+ # @return [String, nil]
134
+ optional :payment_provider_id, String, nil?: true
135
+
136
+ # @!attribute shipping_address
137
+ #
138
+ # @return [Orb::Models::Address, nil]
139
+ optional :shipping_address, -> { Orb::Address }, nil?: true
140
+
141
+ # @!attribute tax_id
142
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
143
+ # added to the headers of invoices.
144
+ #
145
+ # ### Supported Tax ID Countries and Types
146
+ #
147
+ # | Country | Type | Description |
148
+ # | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
149
+ # | Albania | `al_tin` | Albania Tax Identification Number |
150
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
151
+ # | Angola | `ao_tin` | Angola Tax Identification Number |
152
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
153
+ # | Armenia | `am_tin` | Armenia Tax Identification Number |
154
+ # | Aruba | `aw_tin` | Aruba Tax Identification Number |
155
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
156
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
157
+ # | Austria | `eu_vat` | European VAT Number |
158
+ # | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
159
+ # | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
160
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
161
+ # | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
162
+ # | Barbados | `bb_tin` | Barbados Tax Identification Number |
163
+ # | Belarus | `by_tin` | Belarus TIN Number |
164
+ # | Belgium | `eu_vat` | European VAT Number |
165
+ # | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
166
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
167
+ # | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
168
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
169
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
170
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
171
+ # | Bulgaria | `eu_vat` | European VAT Number |
172
+ # | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
173
+ # | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
174
+ # | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
175
+ # | Canada | `ca_bn` | Canadian BN |
176
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
177
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
178
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
179
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
180
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
181
+ # | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
182
+ # | Chile | `cl_tin` | Chilean TIN |
183
+ # | China | `cn_tin` | Chinese Tax ID |
184
+ # | Colombia | `co_nit` | Colombian NIT Number |
185
+ # | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
186
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
187
+ # | Croatia | `eu_vat` | European VAT Number |
188
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
189
+ # | Cyprus | `eu_vat` | European VAT Number |
190
+ # | Czech Republic | `eu_vat` | European VAT Number |
191
+ # | Denmark | `eu_vat` | European VAT Number |
192
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
193
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
194
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
195
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
196
+ # | Estonia | `eu_vat` | European VAT Number |
197
+ # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
198
+ # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
199
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
200
+ # | Finland | `eu_vat` | European VAT Number |
201
+ # | France | `eu_vat` | European VAT Number |
202
+ # | Georgia | `ge_vat` | Georgian VAT |
203
+ # | Germany | `de_stn` | German Tax Number (Steuernummer) |
204
+ # | Germany | `eu_vat` | European VAT Number |
205
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
206
+ # | Greece | `eu_vat` | European VAT Number |
207
+ # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
208
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
209
+ # | Hungary | `eu_vat` | European VAT Number |
210
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
211
+ # | Iceland | `is_vat` | Icelandic VAT |
212
+ # | India | `in_gst` | Indian GST Number |
213
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
214
+ # | Ireland | `eu_vat` | European VAT Number |
215
+ # | Israel | `il_vat` | Israel VAT |
216
+ # | Italy | `eu_vat` | European VAT Number |
217
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
218
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
219
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
220
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
221
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
222
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
223
+ # | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
224
+ # | Laos | `la_tin` | Laos Tax Identification Number |
225
+ # | Latvia | `eu_vat` | European VAT Number |
226
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
227
+ # | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
228
+ # | Lithuania | `eu_vat` | European VAT Number |
229
+ # | Luxembourg | `eu_vat` | European VAT Number |
230
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
231
+ # | Malaysia | `my_itn` | Malaysian ITN |
232
+ # | Malaysia | `my_sst` | Malaysian SST Number |
233
+ # | Malta | `eu_vat` | European VAT Number |
234
+ # | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
235
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
236
+ # | Moldova | `md_vat` | Moldova VAT Number |
237
+ # | Montenegro | `me_pib` | Montenegro PIB Number |
238
+ # | Morocco | `ma_vat` | Morocco VAT Number |
239
+ # | Nepal | `np_pan` | Nepal PAN Number |
240
+ # | Netherlands | `eu_vat` | European VAT Number |
241
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
242
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
243
+ # | North Macedonia | `mk_vat` | North Macedonia VAT Number |
244
+ # | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
245
+ # | Norway | `no_vat` | Norwegian VAT Number |
246
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
247
+ # | Oman | `om_vat` | Omani VAT Number |
248
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
249
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
250
+ # | Philippines | `ph_tin` | Philippines Tax Identification Number |
251
+ # | Poland | `eu_vat` | European VAT Number |
252
+ # | Poland | `pl_nip` | Polish Tax ID Number |
253
+ # | Portugal | `eu_vat` | European VAT Number |
254
+ # | Romania | `eu_vat` | European VAT Number |
255
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
256
+ # | Russia | `ru_inn` | Russian INN |
257
+ # | Russia | `ru_kpp` | Russian KPP |
258
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
259
+ # | Senegal | `sn_ninea` | Senegal NINEA Number |
260
+ # | Serbia | `rs_pib` | Serbian PIB Number |
261
+ # | Singapore | `sg_gst` | Singaporean GST |
262
+ # | Singapore | `sg_uen` | Singaporean UEN |
263
+ # | Slovakia | `eu_vat` | European VAT Number |
264
+ # | Slovenia | `eu_vat` | European VAT Number |
265
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
266
+ # | South Africa | `za_vat` | South African VAT Number |
267
+ # | South Korea | `kr_brn` | Korean BRN |
268
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
269
+ # | Spain | `eu_vat` | European VAT Number |
270
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
271
+ # | Suriname | `sr_fin` | Suriname FIN Number |
272
+ # | Sweden | `eu_vat` | European VAT Number |
273
+ # | Switzerland | `ch_uid` | Switzerland UID Number |
274
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
275
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
276
+ # | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
277
+ # | Tanzania | `tz_vat` | Tanzania VAT Number |
278
+ # | Thailand | `th_vat` | Thai VAT |
279
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
280
+ # | Uganda | `ug_tin` | Uganda Tax Identification Number |
281
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
282
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
283
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
284
+ # | United States | `us_ein` | United States EIN |
285
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
286
+ # | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
287
+ # | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
288
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
289
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
290
+ # | Zambia | `zm_tin` | Zambia Tax Identification Number |
291
+ # | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
292
+ #
293
+ # @return [Orb::Models::CustomerTaxID, nil]
294
+ optional :tax_id, -> { Orb::CustomerTaxID }, nil?: true
295
+
296
+ # @!method initialize(auto_collection: nil, billing_address: nil, default_payment_method_id: nil, email: nil, email_delivery: nil, external_customer_id: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, shipping_address: nil, tax_id: nil)
297
+ # Some parameter documentations has been truncated, see
298
+ # {Orb::Models::CustomerEditedWebhookEvent::Properties::PreviousAttributes} for
299
+ # more details.
300
+ #
301
+ # metadata values are non-null on the wire (deleting a key removes it from
302
+ # storage); the Optional[str] values only exist on the new half of a metadata
303
+ # FieldChange.
304
+ #
305
+ # @param auto_collection [Boolean, nil]
306
+ #
307
+ # @param billing_address [Orb::Models::Address, nil]
308
+ #
309
+ # @param default_payment_method_id [String, nil]
310
+ #
311
+ # @param email [String, nil]
312
+ #
313
+ # @param email_delivery [Boolean, nil]
314
+ #
315
+ # @param external_customer_id [String, nil]
316
+ #
317
+ # @param metadata [Hash{Symbol=>String}, nil]
318
+ #
319
+ # @param name [String, nil]
320
+ #
321
+ # @param payment_provider [String, nil]
322
+ #
323
+ # @param payment_provider_id [String, nil]
324
+ #
325
+ # @param shipping_address [Orb::Models::Address, nil]
326
+ #
327
+ # @param tax_id [Orb::Models::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
328
+ end
329
+ end
330
+
331
+ # The event this payload describes.
332
+ #
333
+ # @see Orb::Models::CustomerEditedWebhookEvent#type
334
+ module Type
335
+ extend Orb::Internal::Type::Enum
336
+
337
+ CUSTOMER_EDITED = :"customer.edited"
338
+
339
+ # @!method self.values
340
+ # @return [Array<Symbol>]
341
+ end
342
+ end
343
+ end
344
+ end
@@ -0,0 +1,100 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ class DataExportsTransferErrorWebhookEvent < 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 created_at
13
+ # The time at which this event was created, to the second.
14
+ #
15
+ # @return [Time]
16
+ required :created_at, Time
17
+
18
+ # @!attribute properties
19
+ #
20
+ # @return [Orb::Models::DataExportsTransferErrorWebhookEvent::Properties]
21
+ required :properties, -> { Orb::DataExportsTransferErrorWebhookEvent::Properties }
22
+
23
+ # @!attribute type
24
+ # The event this payload describes.
25
+ #
26
+ # @return [Symbol, Orb::Models::DataExportsTransferErrorWebhookEvent::Type]
27
+ required :type, enum: -> { Orb::DataExportsTransferErrorWebhookEvent::Type }
28
+
29
+ # @!method initialize(id:, created_at:, properties:, type:)
30
+ # Issued when a data export transfer fails.
31
+ #
32
+ # @param id [String] The ID of this webhook event.
33
+ #
34
+ # @param created_at [Time] The time at which this event was created, to the second.
35
+ #
36
+ # @param properties [Orb::Models::DataExportsTransferErrorWebhookEvent::Properties]
37
+ #
38
+ # @param type [Symbol, Orb::Models::DataExportsTransferErrorWebhookEvent::Type] The event this payload describes.
39
+
40
+ # @see Orb::Models::DataExportsTransferErrorWebhookEvent#properties
41
+ class Properties < Orb::Internal::Type::BaseModel
42
+ # @!attribute description
43
+ #
44
+ # @return [String]
45
+ required :description, String
46
+
47
+ # @!attribute destination_name
48
+ #
49
+ # @return [String]
50
+ required :destination_name, String
51
+
52
+ # @!attribute resources
53
+ #
54
+ # @return [Array<String>]
55
+ required :resources, Orb::Internal::Type::ArrayOf[String]
56
+
57
+ # @!attribute rows_transferred
58
+ #
59
+ # @return [Integer]
60
+ required :rows_transferred, Integer
61
+
62
+ # @!attribute transfer_blamed_party
63
+ #
64
+ # @return [String]
65
+ required :transfer_blamed_party, String
66
+
67
+ # @!attribute transfer_ended_at
68
+ #
69
+ # @return [Time]
70
+ required :transfer_ended_at, Time
71
+
72
+ # @!attribute transfer_started_at
73
+ #
74
+ # @return [Time]
75
+ required :transfer_started_at, Time
76
+
77
+ # @!method initialize(description:, destination_name:, resources:, rows_transferred:, transfer_blamed_party:, transfer_ended_at:, transfer_started_at:)
78
+ # @param description [String]
79
+ # @param destination_name [String]
80
+ # @param resources [Array<String>]
81
+ # @param rows_transferred [Integer]
82
+ # @param transfer_blamed_party [String]
83
+ # @param transfer_ended_at [Time]
84
+ # @param transfer_started_at [Time]
85
+ end
86
+
87
+ # The event this payload describes.
88
+ #
89
+ # @see Orb::Models::DataExportsTransferErrorWebhookEvent#type
90
+ module Type
91
+ extend Orb::Internal::Type::Enum
92
+
93
+ DATA_EXPORTS_TRANSFER_ERROR = :"data_exports.transfer_error"
94
+
95
+ # @!method self.values
96
+ # @return [Array<Symbol>]
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,94 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ class DataExportsTransferSuccessWebhookEvent < 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 created_at
13
+ # The time at which this event was created, to the second.
14
+ #
15
+ # @return [Time]
16
+ required :created_at, Time
17
+
18
+ # @!attribute properties
19
+ #
20
+ # @return [Orb::Models::DataExportsTransferSuccessWebhookEvent::Properties]
21
+ required :properties, -> { Orb::DataExportsTransferSuccessWebhookEvent::Properties }
22
+
23
+ # @!attribute type
24
+ # The event this payload describes.
25
+ #
26
+ # @return [Symbol, Orb::Models::DataExportsTransferSuccessWebhookEvent::Type]
27
+ required :type, enum: -> { Orb::DataExportsTransferSuccessWebhookEvent::Type }
28
+
29
+ # @!method initialize(id:, created_at:, properties:, type:)
30
+ # Issued when a data export transfer succeeds.
31
+ #
32
+ # @param id [String] The ID of this webhook event.
33
+ #
34
+ # @param created_at [Time] The time at which this event was created, to the second.
35
+ #
36
+ # @param properties [Orb::Models::DataExportsTransferSuccessWebhookEvent::Properties]
37
+ #
38
+ # @param type [Symbol, Orb::Models::DataExportsTransferSuccessWebhookEvent::Type] The event this payload describes.
39
+
40
+ # @see Orb::Models::DataExportsTransferSuccessWebhookEvent#properties
41
+ class Properties < Orb::Internal::Type::BaseModel
42
+ # @!attribute description
43
+ #
44
+ # @return [String]
45
+ required :description, String
46
+
47
+ # @!attribute destination_name
48
+ #
49
+ # @return [String]
50
+ required :destination_name, String
51
+
52
+ # @!attribute resources
53
+ #
54
+ # @return [Array<String>]
55
+ required :resources, Orb::Internal::Type::ArrayOf[String]
56
+
57
+ # @!attribute rows_transferred
58
+ #
59
+ # @return [Integer]
60
+ required :rows_transferred, Integer
61
+
62
+ # @!attribute transfer_ended_at
63
+ #
64
+ # @return [Time]
65
+ required :transfer_ended_at, Time
66
+
67
+ # @!attribute transfer_started_at
68
+ #
69
+ # @return [Time]
70
+ required :transfer_started_at, Time
71
+
72
+ # @!method initialize(description:, destination_name:, resources:, rows_transferred:, transfer_ended_at:, transfer_started_at:)
73
+ # @param description [String]
74
+ # @param destination_name [String]
75
+ # @param resources [Array<String>]
76
+ # @param rows_transferred [Integer]
77
+ # @param transfer_ended_at [Time]
78
+ # @param transfer_started_at [Time]
79
+ end
80
+
81
+ # The event this payload describes.
82
+ #
83
+ # @see Orb::Models::DataExportsTransferSuccessWebhookEvent#type
84
+ module Type
85
+ extend Orb::Internal::Type::Enum
86
+
87
+ DATA_EXPORTS_TRANSFER_SUCCESS = :"data_exports.transfer_success"
88
+
89
+ # @!method self.values
90
+ # @return [Array<Symbol>]
91
+ end
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,105 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ class EventUnmatchedEventWebhookEvent < 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 created_at
13
+ # The time at which this event was created, to the second.
14
+ #
15
+ # @return [Time]
16
+ required :created_at, Time
17
+
18
+ # @!attribute properties
19
+ #
20
+ # @return [Orb::Models::EventUnmatchedEventWebhookEvent::Properties]
21
+ required :properties, -> { Orb::EventUnmatchedEventWebhookEvent::Properties }
22
+
23
+ # @!attribute type
24
+ # The event this payload describes.
25
+ #
26
+ # @return [Symbol, Orb::Models::EventUnmatchedEventWebhookEvent::Type]
27
+ required :type, enum: -> { Orb::EventUnmatchedEventWebhookEvent::Type }
28
+
29
+ # @!method initialize(id:, created_at:, properties:, type:)
30
+ # Issued when an event does not match any customer.
31
+ #
32
+ # @param id [String] The ID of this webhook event.
33
+ #
34
+ # @param created_at [Time] The time at which this event was created, to the second.
35
+ #
36
+ # @param properties [Orb::Models::EventUnmatchedEventWebhookEvent::Properties]
37
+ #
38
+ # @param type [Symbol, Orb::Models::EventUnmatchedEventWebhookEvent::Type] The event this payload describes.
39
+
40
+ # @see Orb::Models::EventUnmatchedEventWebhookEvent#properties
41
+ class Properties < Orb::Internal::Type::BaseModel
42
+ # @!attribute event
43
+ #
44
+ # @return [Orb::Models::EventUnmatchedEventWebhookEvent::Properties::Event]
45
+ required :event, -> { Orb::EventUnmatchedEventWebhookEvent::Properties::Event }
46
+
47
+ # @!method initialize(event:)
48
+ # @param event [Orb::Models::EventUnmatchedEventWebhookEvent::Properties::Event]
49
+
50
+ # @see Orb::Models::EventUnmatchedEventWebhookEvent::Properties#event
51
+ class Event < Orb::Internal::Type::BaseModel
52
+ # @!attribute customer_id
53
+ #
54
+ # @return [String, nil]
55
+ required :customer_id, String, nil?: true
56
+
57
+ # @!attribute event_name
58
+ #
59
+ # @return [String]
60
+ required :event_name, String
61
+
62
+ # @!attribute external_customer_id
63
+ #
64
+ # @return [String, nil]
65
+ required :external_customer_id, String, nil?: true
66
+
67
+ # @!attribute idempotency_key
68
+ #
69
+ # @return [String]
70
+ required :idempotency_key, String
71
+
72
+ # @!attribute properties
73
+ #
74
+ # @return [Hash{Symbol=>Object}]
75
+ required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
76
+
77
+ # @!attribute timestamp
78
+ #
79
+ # @return [Time]
80
+ required :timestamp, Time
81
+
82
+ # @!method initialize(customer_id:, event_name:, external_customer_id:, idempotency_key:, properties:, timestamp:)
83
+ # @param customer_id [String, nil]
84
+ # @param event_name [String]
85
+ # @param external_customer_id [String, nil]
86
+ # @param idempotency_key [String]
87
+ # @param properties [Hash{Symbol=>Object}]
88
+ # @param timestamp [Time]
89
+ end
90
+ end
91
+
92
+ # The event this payload describes.
93
+ #
94
+ # @see Orb::Models::EventUnmatchedEventWebhookEvent#type
95
+ module Type
96
+ extend Orb::Internal::Type::Enum
97
+
98
+ EVENT_UNMATCHED_EVENT = :"event.unmatched_event"
99
+
100
+ # @!method self.values
101
+ # @return [Array<Symbol>]
102
+ end
103
+ end
104
+ end
105
+ end