orb-billing 1.17.0 → 1.18.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 (48) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/alert_delete_params.rb +20 -0
  5. data/lib/orb/models/customer_create_portal_session_by_external_id_params.rb +44 -0
  6. data/lib/orb/models/customer_create_portal_session_by_external_id_response.rb +40 -0
  7. data/lib/orb/models/customer_create_portal_session_params.rb +44 -0
  8. data/lib/orb/models/customer_create_portal_session_response.rb +40 -0
  9. data/lib/orb/models/event_ingest_params.rb +1 -12
  10. data/lib/orb/models/event_ingest_response.rb +1 -28
  11. data/lib/orb/models/invoice_regenerate_invoice_pdf_params.rb +20 -0
  12. data/lib/orb/models/invoice_regenerate_receipt_pdf_params.rb +20 -0
  13. data/lib/orb/models.rb +11 -0
  14. data/lib/orb/resources/alerts.rb +26 -0
  15. data/lib/orb/resources/customers.rb +66 -0
  16. data/lib/orb/resources/events.rb +2 -4
  17. data/lib/orb/resources/invoices.rb +82 -0
  18. data/lib/orb/version.rb +1 -1
  19. data/lib/orb.rb +7 -0
  20. data/rbi/orb/models/alert_delete_params.rbi +36 -0
  21. data/rbi/orb/models/customer_create_portal_session_by_external_id_params.rbi +74 -0
  22. data/rbi/orb/models/customer_create_portal_session_by_external_id_response.rbi +56 -0
  23. data/rbi/orb/models/customer_create_portal_session_params.rbi +71 -0
  24. data/rbi/orb/models/customer_create_portal_session_response.rbi +56 -0
  25. data/rbi/orb/models/event_ingest_params.rbi +0 -13
  26. data/rbi/orb/models/event_ingest_response.rbi +3 -51
  27. data/rbi/orb/models/invoice_regenerate_invoice_pdf_params.rbi +35 -0
  28. data/rbi/orb/models/invoice_regenerate_receipt_pdf_params.rbi +35 -0
  29. data/rbi/orb/models.rbi +14 -0
  30. data/rbi/orb/resources/alerts.rbi +17 -0
  31. data/rbi/orb/resources/customers.rbi +54 -0
  32. data/rbi/orb/resources/events.rbi +0 -4
  33. data/rbi/orb/resources/invoices.rbi +64 -0
  34. data/sig/orb/models/alert_delete_params.rbs +24 -0
  35. data/sig/orb/models/customer_create_portal_session_by_external_id_params.rbs +40 -0
  36. data/sig/orb/models/customer_create_portal_session_by_external_id_response.rbs +40 -0
  37. data/sig/orb/models/customer_create_portal_session_params.rbs +40 -0
  38. data/sig/orb/models/customer_create_portal_session_response.rbs +40 -0
  39. data/sig/orb/models/event_ingest_params.rbs +1 -11
  40. data/sig/orb/models/event_ingest_response.rbs +3 -26
  41. data/sig/orb/models/invoice_regenerate_invoice_pdf_params.rbs +23 -0
  42. data/sig/orb/models/invoice_regenerate_receipt_pdf_params.rbs +23 -0
  43. data/sig/orb/models.rbs +10 -0
  44. data/sig/orb/resources/alerts.rbs +5 -0
  45. data/sig/orb/resources/customers.rbs +14 -0
  46. data/sig/orb/resources/events.rbs +0 -1
  47. data/sig/orb/resources/invoices.rbs +10 -0
  48. metadata +22 -1
@@ -0,0 +1,24 @@
1
+ module Orb
2
+ module Models
3
+ type alert_delete_params =
4
+ { alert_configuration_id: String }
5
+ & Orb::Internal::Type::request_parameters
6
+
7
+ class AlertDeleteParams < Orb::Internal::Type::BaseModel
8
+ extend Orb::Internal::Type::RequestParameters::Converter
9
+ include Orb::Internal::Type::RequestParameters
10
+
11
+ attr_accessor alert_configuration_id: String
12
+
13
+ def initialize: (
14
+ alert_configuration_id: String,
15
+ ?request_options: Orb::request_opts
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ alert_configuration_id: String,
20
+ request_options: Orb::RequestOptions
21
+ }
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,40 @@
1
+ module Orb
2
+ module Models
3
+ type customer_create_portal_session_by_external_id_params =
4
+ {
5
+ external_customer_id: String,
6
+ expires_in_minutes: Integer,
7
+ invalidate_existing: bool
8
+ }
9
+ & Orb::Internal::Type::request_parameters
10
+
11
+ class CustomerCreatePortalSessionByExternalIDParams < Orb::Internal::Type::BaseModel
12
+ extend Orb::Internal::Type::RequestParameters::Converter
13
+ include Orb::Internal::Type::RequestParameters
14
+
15
+ attr_accessor external_customer_id: String
16
+
17
+ attr_reader expires_in_minutes: Integer?
18
+
19
+ def expires_in_minutes=: (Integer) -> Integer
20
+
21
+ attr_reader invalidate_existing: bool?
22
+
23
+ def invalidate_existing=: (bool) -> bool
24
+
25
+ def initialize: (
26
+ external_customer_id: String,
27
+ ?expires_in_minutes: Integer,
28
+ ?invalidate_existing: bool,
29
+ ?request_options: Orb::request_opts
30
+ ) -> void
31
+
32
+ def to_hash: -> {
33
+ external_customer_id: String,
34
+ expires_in_minutes: Integer,
35
+ invalidate_existing: bool,
36
+ request_options: Orb::RequestOptions
37
+ }
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,40 @@
1
+ module Orb
2
+ module Models
3
+ type customer_create_portal_session_by_external_id_response =
4
+ {
5
+ id: String,
6
+ created_at: Time,
7
+ customer_id: String,
8
+ expires_at: Time?,
9
+ url: String
10
+ }
11
+
12
+ class CustomerCreatePortalSessionByExternalIDResponse < Orb::Internal::Type::BaseModel
13
+ attr_accessor id: String
14
+
15
+ attr_accessor created_at: Time
16
+
17
+ attr_accessor customer_id: String
18
+
19
+ attr_accessor expires_at: Time?
20
+
21
+ attr_accessor url: String
22
+
23
+ def initialize: (
24
+ id: String,
25
+ created_at: Time,
26
+ customer_id: String,
27
+ expires_at: Time?,
28
+ url: String
29
+ ) -> void
30
+
31
+ def to_hash: -> {
32
+ id: String,
33
+ created_at: Time,
34
+ customer_id: String,
35
+ expires_at: Time?,
36
+ url: String
37
+ }
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,40 @@
1
+ module Orb
2
+ module Models
3
+ type customer_create_portal_session_params =
4
+ {
5
+ customer_id: String,
6
+ expires_in_minutes: Integer,
7
+ invalidate_existing: bool
8
+ }
9
+ & Orb::Internal::Type::request_parameters
10
+
11
+ class CustomerCreatePortalSessionParams < Orb::Internal::Type::BaseModel
12
+ extend Orb::Internal::Type::RequestParameters::Converter
13
+ include Orb::Internal::Type::RequestParameters
14
+
15
+ attr_accessor customer_id: String
16
+
17
+ attr_reader expires_in_minutes: Integer?
18
+
19
+ def expires_in_minutes=: (Integer) -> Integer
20
+
21
+ attr_reader invalidate_existing: bool?
22
+
23
+ def invalidate_existing=: (bool) -> bool
24
+
25
+ def initialize: (
26
+ customer_id: String,
27
+ ?expires_in_minutes: Integer,
28
+ ?invalidate_existing: bool,
29
+ ?request_options: Orb::request_opts
30
+ ) -> void
31
+
32
+ def to_hash: -> {
33
+ customer_id: String,
34
+ expires_in_minutes: Integer,
35
+ invalidate_existing: bool,
36
+ request_options: Orb::RequestOptions
37
+ }
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,40 @@
1
+ module Orb
2
+ module Models
3
+ type customer_create_portal_session_response =
4
+ {
5
+ id: String,
6
+ created_at: Time,
7
+ customer_id: String,
8
+ expires_at: Time?,
9
+ url: String
10
+ }
11
+
12
+ class CustomerCreatePortalSessionResponse < Orb::Internal::Type::BaseModel
13
+ attr_accessor id: String
14
+
15
+ attr_accessor created_at: Time
16
+
17
+ attr_accessor customer_id: String
18
+
19
+ attr_accessor expires_at: Time?
20
+
21
+ attr_accessor url: String
22
+
23
+ def initialize: (
24
+ id: String,
25
+ created_at: Time,
26
+ customer_id: String,
27
+ expires_at: Time?,
28
+ url: String
29
+ ) -> void
30
+
31
+ def to_hash: -> {
32
+ id: String,
33
+ created_at: Time,
34
+ customer_id: String,
35
+ expires_at: Time?,
36
+ url: String
37
+ }
38
+ end
39
+ end
40
+ end
@@ -1,11 +1,7 @@
1
1
  module Orb
2
2
  module Models
3
3
  type event_ingest_params =
4
- {
5
- events: ::Array[Orb::EventIngestParams::Event],
6
- backfill_id: String?,
7
- debug: bool
8
- }
4
+ { events: ::Array[Orb::EventIngestParams::Event], backfill_id: String? }
9
5
  & Orb::Internal::Type::request_parameters
10
6
 
11
7
  class EventIngestParams < Orb::Internal::Type::BaseModel
@@ -16,21 +12,15 @@ module Orb
16
12
 
17
13
  attr_accessor backfill_id: String?
18
14
 
19
- attr_reader debug: bool?
20
-
21
- def debug=: (bool) -> bool
22
-
23
15
  def initialize: (
24
16
  events: ::Array[Orb::EventIngestParams::Event],
25
17
  ?backfill_id: String?,
26
- ?debug: bool,
27
18
  ?request_options: Orb::request_opts
28
19
  ) -> void
29
20
 
30
21
  def to_hash: -> {
31
22
  events: ::Array[Orb::EventIngestParams::Event],
32
23
  backfill_id: String?,
33
- debug: bool,
34
24
  request_options: Orb::RequestOptions
35
25
  }
36
26
 
@@ -2,23 +2,18 @@ module Orb
2
2
  module Models
3
3
  type event_ingest_response =
4
4
  {
5
- validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed],
6
- debug: Orb::Models::EventIngestResponse::Debug?
5
+ validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed]
7
6
  }
8
7
 
9
8
  class EventIngestResponse < Orb::Internal::Type::BaseModel
10
9
  attr_accessor validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed]
11
10
 
12
- attr_accessor debug: Orb::Models::EventIngestResponse::Debug?
13
-
14
11
  def initialize: (
15
- validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed],
16
- ?debug: Orb::Models::EventIngestResponse::Debug?
12
+ validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed]
17
13
  ) -> void
18
14
 
19
15
  def to_hash: -> {
20
- validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed],
21
- debug: Orb::Models::EventIngestResponse::Debug?
16
+ validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed]
22
17
  }
23
18
 
24
19
  type validation_failed =
@@ -39,24 +34,6 @@ module Orb
39
34
  validation_errors: ::Array[String]
40
35
  }
41
36
  end
42
-
43
- type debug = { duplicate: ::Array[String], ingested: ::Array[String] }
44
-
45
- class Debug < Orb::Internal::Type::BaseModel
46
- attr_accessor duplicate: ::Array[String]
47
-
48
- attr_accessor ingested: ::Array[String]
49
-
50
- def initialize: (
51
- duplicate: ::Array[String],
52
- ingested: ::Array[String]
53
- ) -> void
54
-
55
- def to_hash: -> {
56
- duplicate: ::Array[String],
57
- ingested: ::Array[String]
58
- }
59
- end
60
37
  end
61
38
  end
62
39
  end
@@ -0,0 +1,23 @@
1
+ module Orb
2
+ module Models
3
+ type invoice_regenerate_invoice_pdf_params =
4
+ { invoice_id: String } & Orb::Internal::Type::request_parameters
5
+
6
+ class InvoiceRegenerateInvoicePdfParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ attr_accessor invoice_id: String
11
+
12
+ def initialize: (
13
+ invoice_id: String,
14
+ ?request_options: Orb::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> {
18
+ invoice_id: String,
19
+ request_options: Orb::RequestOptions
20
+ }
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,23 @@
1
+ module Orb
2
+ module Models
3
+ type invoice_regenerate_receipt_pdf_params =
4
+ { invoice_id: String } & Orb::Internal::Type::request_parameters
5
+
6
+ class InvoiceRegenerateReceiptPdfParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ attr_accessor invoice_id: String
11
+
12
+ def initialize: (
13
+ invoice_id: String,
14
+ ?request_options: Orb::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> {
18
+ invoice_id: String,
19
+ request_options: Orb::RequestOptions
20
+ }
21
+ end
22
+ end
23
+ end
data/sig/orb/models.rbs CHANGED
@@ -17,6 +17,8 @@ module Orb
17
17
 
18
18
  class AlertCreateForSubscriptionParams = Orb::Models::AlertCreateForSubscriptionParams
19
19
 
20
+ class AlertDeleteParams = Orb::Models::AlertDeleteParams
21
+
20
22
  class AlertDisableParams = Orb::Models::AlertDisableParams
21
23
 
22
24
  class AlertEnableParams = Orb::Models::AlertEnableParams
@@ -99,6 +101,10 @@ module Orb
99
101
 
100
102
  class CustomerCreateParams = Orb::Models::CustomerCreateParams
101
103
 
104
+ class CustomerCreatePortalSessionByExternalIDParams = Orb::Models::CustomerCreatePortalSessionByExternalIDParams
105
+
106
+ class CustomerCreatePortalSessionParams = Orb::Models::CustomerCreatePortalSessionParams
107
+
102
108
  class CustomerDeleteParams = Orb::Models::CustomerDeleteParams
103
109
 
104
110
  class CustomerFetchByExternalIDParams = Orb::Models::CustomerFetchByExternalIDParams
@@ -187,6 +193,10 @@ module Orb
187
193
 
188
194
  class InvoicePayParams = Orb::Models::InvoicePayParams
189
195
 
196
+ class InvoiceRegenerateInvoicePdfParams = Orb::Models::InvoiceRegenerateInvoicePdfParams
197
+
198
+ class InvoiceRegenerateReceiptPdfParams = Orb::Models::InvoiceRegenerateReceiptPdfParams
199
+
190
200
  class InvoiceTiny = Orb::Models::InvoiceTiny
191
201
 
192
202
  class InvoiceUpdateParams = Orb::Models::InvoiceUpdateParams
@@ -27,6 +27,11 @@ module Orb
27
27
  ?request_options: Orb::request_opts
28
28
  ) -> Orb::Internal::Page[Orb::Alert]
29
29
 
30
+ def delete: (
31
+ String alert_configuration_id,
32
+ ?request_options: Orb::request_opts
33
+ ) -> nil
34
+
30
35
  def create_for_customer: (
31
36
  String customer_id,
32
37
  currency: String,
@@ -71,6 +71,20 @@ module Orb
71
71
  ?request_options: Orb::request_opts
72
72
  ) -> nil
73
73
 
74
+ def create_portal_session: (
75
+ String customer_id,
76
+ ?expires_in_minutes: Integer,
77
+ ?invalidate_existing: bool,
78
+ ?request_options: Orb::request_opts
79
+ ) -> Orb::Models::CustomerCreatePortalSessionResponse
80
+
81
+ def create_portal_session_by_external_id: (
82
+ String external_customer_id,
83
+ ?expires_in_minutes: Integer,
84
+ ?invalidate_existing: bool,
85
+ ?request_options: Orb::request_opts
86
+ ) -> Orb::Models::CustomerCreatePortalSessionByExternalIDResponse
87
+
74
88
  def fetch: (
75
89
  String customer_id,
76
90
  ?request_options: Orb::request_opts
@@ -23,7 +23,6 @@ module Orb
23
23
  def ingest: (
24
24
  events: ::Array[Orb::EventIngestParams::Event],
25
25
  ?backfill_id: String?,
26
- ?debug: bool,
27
26
  ?request_options: Orb::request_opts
28
27
  ) -> Orb::Models::EventIngestResponse
29
28
 
@@ -115,6 +115,16 @@ module Orb
115
115
  ?request_options: Orb::request_opts
116
116
  ) -> Orb::Invoice
117
117
 
118
+ def regenerate_invoice_pdf: (
119
+ String invoice_id,
120
+ ?request_options: Orb::request_opts
121
+ ) -> Orb::Invoice
122
+
123
+ def regenerate_receipt_pdf: (
124
+ String invoice_id,
125
+ ?request_options: Orb::request_opts
126
+ ) -> Orb::Invoice
127
+
118
128
  def `void`: (
119
129
  String invoice_id,
120
130
  ?request_options: Orb::request_opts
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: orb-billing
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.17.0
4
+ version: 1.18.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Orb
@@ -77,6 +77,7 @@ files:
77
77
  - lib/orb/models/alert_create_for_customer_params.rb
78
78
  - lib/orb/models/alert_create_for_external_customer_params.rb
79
79
  - lib/orb/models/alert_create_for_subscription_params.rb
80
+ - lib/orb/models/alert_delete_params.rb
80
81
  - lib/orb/models/alert_disable_params.rb
81
82
  - lib/orb/models/alert_enable_params.rb
82
83
  - lib/orb/models/alert_list_params.rb
@@ -123,6 +124,10 @@ files:
123
124
  - lib/orb/models/custom_expiration.rb
124
125
  - lib/orb/models/customer.rb
125
126
  - lib/orb/models/customer_create_params.rb
127
+ - lib/orb/models/customer_create_portal_session_by_external_id_params.rb
128
+ - lib/orb/models/customer_create_portal_session_by_external_id_response.rb
129
+ - lib/orb/models/customer_create_portal_session_params.rb
130
+ - lib/orb/models/customer_create_portal_session_response.rb
126
131
  - lib/orb/models/customer_delete_params.rb
127
132
  - lib/orb/models/customer_fetch_by_external_id_params.rb
128
133
  - lib/orb/models/customer_fetch_params.rb
@@ -224,6 +229,8 @@ files:
224
229
  - lib/orb/models/invoice_list_summary_response.rb
225
230
  - lib/orb/models/invoice_mark_paid_params.rb
226
231
  - lib/orb/models/invoice_pay_params.rb
232
+ - lib/orb/models/invoice_regenerate_invoice_pdf_params.rb
233
+ - lib/orb/models/invoice_regenerate_receipt_pdf_params.rb
227
234
  - lib/orb/models/invoice_tiny.rb
228
235
  - lib/orb/models/invoice_update_params.rb
229
236
  - lib/orb/models/invoice_void_params.rb
@@ -517,6 +524,7 @@ files:
517
524
  - rbi/orb/models/alert_create_for_customer_params.rbi
518
525
  - rbi/orb/models/alert_create_for_external_customer_params.rbi
519
526
  - rbi/orb/models/alert_create_for_subscription_params.rbi
527
+ - rbi/orb/models/alert_delete_params.rbi
520
528
  - rbi/orb/models/alert_disable_params.rbi
521
529
  - rbi/orb/models/alert_enable_params.rbi
522
530
  - rbi/orb/models/alert_list_params.rbi
@@ -563,6 +571,10 @@ files:
563
571
  - rbi/orb/models/custom_expiration.rbi
564
572
  - rbi/orb/models/customer.rbi
565
573
  - rbi/orb/models/customer_create_params.rbi
574
+ - rbi/orb/models/customer_create_portal_session_by_external_id_params.rbi
575
+ - rbi/orb/models/customer_create_portal_session_by_external_id_response.rbi
576
+ - rbi/orb/models/customer_create_portal_session_params.rbi
577
+ - rbi/orb/models/customer_create_portal_session_response.rbi
566
578
  - rbi/orb/models/customer_delete_params.rbi
567
579
  - rbi/orb/models/customer_fetch_by_external_id_params.rbi
568
580
  - rbi/orb/models/customer_fetch_params.rbi
@@ -664,6 +676,8 @@ files:
664
676
  - rbi/orb/models/invoice_list_summary_response.rbi
665
677
  - rbi/orb/models/invoice_mark_paid_params.rbi
666
678
  - rbi/orb/models/invoice_pay_params.rbi
679
+ - rbi/orb/models/invoice_regenerate_invoice_pdf_params.rbi
680
+ - rbi/orb/models/invoice_regenerate_receipt_pdf_params.rbi
667
681
  - rbi/orb/models/invoice_tiny.rbi
668
682
  - rbi/orb/models/invoice_update_params.rbi
669
683
  - rbi/orb/models/invoice_void_params.rbi
@@ -956,6 +970,7 @@ files:
956
970
  - sig/orb/models/alert_create_for_customer_params.rbs
957
971
  - sig/orb/models/alert_create_for_external_customer_params.rbs
958
972
  - sig/orb/models/alert_create_for_subscription_params.rbs
973
+ - sig/orb/models/alert_delete_params.rbs
959
974
  - sig/orb/models/alert_disable_params.rbs
960
975
  - sig/orb/models/alert_enable_params.rbs
961
976
  - sig/orb/models/alert_list_params.rbs
@@ -1002,6 +1017,10 @@ files:
1002
1017
  - sig/orb/models/custom_expiration.rbs
1003
1018
  - sig/orb/models/customer.rbs
1004
1019
  - sig/orb/models/customer_create_params.rbs
1020
+ - sig/orb/models/customer_create_portal_session_by_external_id_params.rbs
1021
+ - sig/orb/models/customer_create_portal_session_by_external_id_response.rbs
1022
+ - sig/orb/models/customer_create_portal_session_params.rbs
1023
+ - sig/orb/models/customer_create_portal_session_response.rbs
1005
1024
  - sig/orb/models/customer_delete_params.rbs
1006
1025
  - sig/orb/models/customer_fetch_by_external_id_params.rbs
1007
1026
  - sig/orb/models/customer_fetch_params.rbs
@@ -1103,6 +1122,8 @@ files:
1103
1122
  - sig/orb/models/invoice_list_summary_response.rbs
1104
1123
  - sig/orb/models/invoice_mark_paid_params.rbs
1105
1124
  - sig/orb/models/invoice_pay_params.rbs
1125
+ - sig/orb/models/invoice_regenerate_invoice_pdf_params.rbs
1126
+ - sig/orb/models/invoice_regenerate_receipt_pdf_params.rbs
1106
1127
  - sig/orb/models/invoice_tiny.rbs
1107
1128
  - sig/orb/models/invoice_update_params.rbs
1108
1129
  - sig/orb/models/invoice_void_params.rbs