orb-billing 1.17.0 → 1.19.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +17 -0
- data/README.md +1 -1
- data/lib/orb/models/alert_delete_params.rb +20 -0
- data/lib/orb/models/customer_create_portal_session_by_external_id_params.rb +44 -0
- data/lib/orb/models/customer_create_portal_session_by_external_id_response.rb +40 -0
- data/lib/orb/models/customer_create_portal_session_params.rb +44 -0
- data/lib/orb/models/customer_create_portal_session_response.rb +40 -0
- data/lib/orb/models/event_ingest_params.rb +1 -12
- data/lib/orb/models/event_ingest_response.rb +1 -28
- data/lib/orb/models/invoice_create_params.rb +9 -8
- data/lib/orb/models/invoice_regenerate_invoice_pdf_params.rb +20 -0
- data/lib/orb/models/invoice_regenerate_receipt_pdf_params.rb +20 -0
- data/lib/orb/models.rb +11 -0
- data/lib/orb/resources/alerts.rb +26 -0
- data/lib/orb/resources/customers.rb +66 -0
- data/lib/orb/resources/events.rb +2 -4
- data/lib/orb/resources/invoices.rb +84 -2
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +7 -0
- data/rbi/orb/models/alert_delete_params.rbi +36 -0
- data/rbi/orb/models/customer_create_portal_session_by_external_id_params.rbi +74 -0
- data/rbi/orb/models/customer_create_portal_session_by_external_id_response.rbi +56 -0
- data/rbi/orb/models/customer_create_portal_session_params.rbi +71 -0
- data/rbi/orb/models/customer_create_portal_session_response.rbi +56 -0
- data/rbi/orb/models/event_ingest_params.rbi +0 -13
- data/rbi/orb/models/event_ingest_response.rbi +3 -51
- data/rbi/orb/models/invoice_create_params.rbi +14 -12
- data/rbi/orb/models/invoice_regenerate_invoice_pdf_params.rbi +35 -0
- data/rbi/orb/models/invoice_regenerate_receipt_pdf_params.rbi +35 -0
- data/rbi/orb/models.rbi +14 -0
- data/rbi/orb/resources/alerts.rbi +17 -0
- data/rbi/orb/resources/customers.rbi +54 -0
- data/rbi/orb/resources/events.rbi +0 -4
- data/rbi/orb/resources/invoices.rbi +71 -6
- data/sig/orb/models/alert_delete_params.rbs +24 -0
- data/sig/orb/models/customer_create_portal_session_by_external_id_params.rbs +40 -0
- data/sig/orb/models/customer_create_portal_session_by_external_id_response.rbs +40 -0
- data/sig/orb/models/customer_create_portal_session_params.rbs +40 -0
- data/sig/orb/models/customer_create_portal_session_response.rbs +40 -0
- data/sig/orb/models/event_ingest_params.rbs +1 -11
- data/sig/orb/models/event_ingest_response.rbs +3 -26
- data/sig/orb/models/invoice_regenerate_invoice_pdf_params.rbs +23 -0
- data/sig/orb/models/invoice_regenerate_receipt_pdf_params.rbs +23 -0
- data/sig/orb/models.rbs +10 -0
- data/sig/orb/resources/alerts.rbs +5 -0
- data/sig/orb/resources/customers.rbs +14 -0
- data/sig/orb/resources/events.rbs +0 -1
- data/sig/orb/resources/invoices.rbs +10 -0
- metadata +22 -1
|
@@ -639,6 +639,60 @@ module Orb
|
|
|
639
639
|
def delete(customer_id, request_options: {})
|
|
640
640
|
end
|
|
641
641
|
|
|
642
|
+
# Creates a portal session for the customer, returning a short-lived URL that
|
|
643
|
+
# provides authenticated access to the customer's billing portal. The session
|
|
644
|
+
# expires after `expires_in_minutes` (default 60, max 180). By default, creating a
|
|
645
|
+
# new session invalidates any other active portal sessions for the customer; pass
|
|
646
|
+
# `invalidate_existing=false` to allow concurrent sessions.
|
|
647
|
+
sig do
|
|
648
|
+
params(
|
|
649
|
+
customer_id: String,
|
|
650
|
+
expires_in_minutes: Integer,
|
|
651
|
+
invalidate_existing: T::Boolean,
|
|
652
|
+
request_options: Orb::RequestOptions::OrHash
|
|
653
|
+
).returns(Orb::Models::CustomerCreatePortalSessionResponse)
|
|
654
|
+
end
|
|
655
|
+
def create_portal_session(
|
|
656
|
+
customer_id,
|
|
657
|
+
# Duration in minutes until the portal session expires. Defaults to 60.
|
|
658
|
+
# Maximum 180.
|
|
659
|
+
expires_in_minutes: nil,
|
|
660
|
+
# When true (default), creating this session soft-deletes any other active portal
|
|
661
|
+
# sessions for the customer. Set to false to allow concurrent sessions — useful
|
|
662
|
+
# when minting portal links for multiple authenticated end-users at once. The
|
|
663
|
+
# customer's permanent portal link (if any) is never invalidated by this.
|
|
664
|
+
invalidate_existing: nil,
|
|
665
|
+
request_options: {}
|
|
666
|
+
)
|
|
667
|
+
end
|
|
668
|
+
|
|
669
|
+
# Creates a portal session for the customer, returning a short-lived URL that
|
|
670
|
+
# provides authenticated access to the customer's billing portal. The session
|
|
671
|
+
# expires after `expires_in_minutes` (default 60, max 180). By default, creating a
|
|
672
|
+
# new session invalidates any other active portal sessions for the customer; pass
|
|
673
|
+
# `invalidate_existing=false` to allow concurrent sessions.
|
|
674
|
+
sig do
|
|
675
|
+
params(
|
|
676
|
+
external_customer_id: String,
|
|
677
|
+
expires_in_minutes: Integer,
|
|
678
|
+
invalidate_existing: T::Boolean,
|
|
679
|
+
request_options: Orb::RequestOptions::OrHash
|
|
680
|
+
).returns(Orb::Models::CustomerCreatePortalSessionByExternalIDResponse)
|
|
681
|
+
end
|
|
682
|
+
def create_portal_session_by_external_id(
|
|
683
|
+
external_customer_id,
|
|
684
|
+
# Duration in minutes until the portal session expires. Defaults to 60.
|
|
685
|
+
# Maximum 180.
|
|
686
|
+
expires_in_minutes: nil,
|
|
687
|
+
# When true (default), creating this session soft-deletes any other active portal
|
|
688
|
+
# sessions for the customer. Set to false to allow concurrent sessions — useful
|
|
689
|
+
# when minting portal links for multiple authenticated end-users at once. The
|
|
690
|
+
# customer's permanent portal link (if any) is never invalidated by this.
|
|
691
|
+
invalidate_existing: nil,
|
|
692
|
+
request_options: {}
|
|
693
|
+
)
|
|
694
|
+
end
|
|
695
|
+
|
|
642
696
|
# This endpoint is used to fetch customer details given an identifier. If the
|
|
643
697
|
# `Customer` is in the process of being deleted, only the properties `id` and
|
|
644
698
|
# `deleted: true` will be returned.
|
|
@@ -324,7 +324,6 @@ module Orb
|
|
|
324
324
|
params(
|
|
325
325
|
events: T::Array[Orb::EventIngestParams::Event::OrHash],
|
|
326
326
|
backfill_id: T.nilable(String),
|
|
327
|
-
debug: T::Boolean,
|
|
328
327
|
request_options: Orb::RequestOptions::OrHash
|
|
329
328
|
).returns(Orb::Models::EventIngestResponse)
|
|
330
329
|
end
|
|
@@ -334,9 +333,6 @@ module Orb
|
|
|
334
333
|
# Query param: If this ingestion request is part of a backfill, this parameter
|
|
335
334
|
# ties the ingested events to the backfill
|
|
336
335
|
backfill_id: nil,
|
|
337
|
-
# Query param: Pending Deprecation: Flag to enable additional debug information in
|
|
338
|
-
# the endpoint response
|
|
339
|
-
debug: nil,
|
|
340
336
|
request_options: {}
|
|
341
337
|
)
|
|
342
338
|
end
|
|
@@ -39,9 +39,10 @@ module Orb
|
|
|
39
39
|
# An ISO 4217 currency string. Must be the same as the customer's currency if it
|
|
40
40
|
# is set.
|
|
41
41
|
currency:,
|
|
42
|
-
# An ISO 8601 date or timestamp, interpreted in the customer's timezone.
|
|
43
|
-
#
|
|
44
|
-
#
|
|
42
|
+
# An ISO 8601 date or timestamp, interpreted in the customer's timezone. If a date
|
|
43
|
+
# is set without a time, `invoice_date` is set to midnight on the chosen date in
|
|
44
|
+
# the customer's timezone. `invoice_date` cannot be more than one year in the
|
|
45
|
+
# future.
|
|
45
46
|
invoice_date:,
|
|
46
47
|
line_items:,
|
|
47
48
|
# Determines whether this invoice will automatically attempt to charge a saved
|
|
@@ -72,9 +73,9 @@ module Orb
|
|
|
72
73
|
# on issue, whereas a value of '30' represents that the customer has 30 days to
|
|
73
74
|
# pay the invoice. Do not set this field if you want to set a custom due date.
|
|
74
75
|
net_terms: nil,
|
|
75
|
-
# When true,
|
|
76
|
-
#
|
|
77
|
-
# false.
|
|
76
|
+
# When true, auto-issues the invoice on the invoice date. If the invoice date is
|
|
77
|
+
# today's date or earlier, the invoice will be issued upon creation. When false,
|
|
78
|
+
# the resulting invoice will require manual review to issue. Defaults to false.
|
|
78
79
|
will_auto_issue: nil,
|
|
79
80
|
request_options: {}
|
|
80
81
|
)
|
|
@@ -402,6 +403,70 @@ module Orb
|
|
|
402
403
|
)
|
|
403
404
|
end
|
|
404
405
|
|
|
406
|
+
# This endpoint triggers a regeneration of the PDF for a finalized invoice.
|
|
407
|
+
#
|
|
408
|
+
# The invoice must be finalized (`issued`, `paid`, `synced`, or `void`) and must
|
|
409
|
+
# already have an existing PDF. The original PDF is archived (not permanently
|
|
410
|
+
# deleted) to maintain an audit trail.
|
|
411
|
+
#
|
|
412
|
+
# **Important Legal Considerations:**
|
|
413
|
+
#
|
|
414
|
+
# Regenerating invoice PDFs may not be permitted in all jurisdictions. Many tax
|
|
415
|
+
# authorities require that issued invoices remain unmodified. Before using this
|
|
416
|
+
# endpoint, ensure that:
|
|
417
|
+
#
|
|
418
|
+
# - Your local tax regulations permit modification of issued billing documents
|
|
419
|
+
# - You have a legitimate business reason (e.g., fixing template errors, updating
|
|
420
|
+
# branding)
|
|
421
|
+
# - You maintain proper records of the original PDF (archived automatically by
|
|
422
|
+
# Orb)
|
|
423
|
+
#
|
|
424
|
+
# Recommended use cases:
|
|
425
|
+
#
|
|
426
|
+
# - Correcting template rendering issues
|
|
427
|
+
# - Applying updated company branding
|
|
428
|
+
# - Updating customer data that was incorrect at issuance
|
|
429
|
+
sig do
|
|
430
|
+
params(
|
|
431
|
+
invoice_id: String,
|
|
432
|
+
request_options: Orb::RequestOptions::OrHash
|
|
433
|
+
).returns(Orb::Invoice)
|
|
434
|
+
end
|
|
435
|
+
def regenerate_invoice_pdf(invoice_id, request_options: {})
|
|
436
|
+
end
|
|
437
|
+
|
|
438
|
+
# This endpoint triggers a regeneration of the receipt PDF for a paid invoice.
|
|
439
|
+
#
|
|
440
|
+
# The invoice must be in `paid` status and must already have an existing receipt
|
|
441
|
+
# PDF. The original PDF is archived (not permanently deleted) to maintain an audit
|
|
442
|
+
# trail.
|
|
443
|
+
#
|
|
444
|
+
# **Important Legal Considerations:**
|
|
445
|
+
#
|
|
446
|
+
# Regenerating receipt PDFs may not be permitted in all jurisdictions. Many tax
|
|
447
|
+
# authorities require that issued receipts remain unmodified. Before using this
|
|
448
|
+
# endpoint, ensure that:
|
|
449
|
+
#
|
|
450
|
+
# - Your local tax regulations permit modification of issued billing documents
|
|
451
|
+
# - You have a legitimate business reason (e.g., fixing template errors, updating
|
|
452
|
+
# branding)
|
|
453
|
+
# - You maintain proper records of the original PDF (archived automatically by
|
|
454
|
+
# Orb)
|
|
455
|
+
#
|
|
456
|
+
# Recommended use cases:
|
|
457
|
+
#
|
|
458
|
+
# - Correcting template rendering issues
|
|
459
|
+
# - Applying updated company branding
|
|
460
|
+
# - Updating customer data that was incorrect at issuance
|
|
461
|
+
sig do
|
|
462
|
+
params(
|
|
463
|
+
invoice_id: String,
|
|
464
|
+
request_options: Orb::RequestOptions::OrHash
|
|
465
|
+
).returns(Orb::Invoice)
|
|
466
|
+
end
|
|
467
|
+
def regenerate_receipt_pdf(invoice_id, request_options: {})
|
|
468
|
+
end
|
|
469
|
+
|
|
405
470
|
# This endpoint allows an invoice's status to be set to the `void` status. This
|
|
406
471
|
# can only be done to invoices that are in the `issued` status.
|
|
407
472
|
#
|
|
@@ -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
|
|
@@ -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
|