inttegro 9.3.0 → 11.0.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 (63) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -2
  3. data/lib/inttegro/app/application.rb +11 -1
  4. data/lib/inttegro/app/capabilities.rb +11 -0
  5. data/lib/inttegro/app/capabilities_response.rb +28 -0
  6. data/lib/inttegro/app/capabilities_response_capabilities.rb +37 -0
  7. data/lib/inttegro/app/capability_projection.rb +39 -0
  8. data/lib/inttegro/app/capability_requirement.rb +41 -0
  9. data/lib/inttegro/app/capability_requirements.rb +28 -0
  10. data/lib/inttegro/app/enabled_capability.rb +35 -0
  11. data/lib/inttegro/app/enabled_capability_status.rb +25 -0
  12. data/lib/inttegro/app/looked_up.rb +18 -0
  13. data/lib/inttegro/app/looked_up_relationship.rb +58 -0
  14. data/lib/inttegro/app/looked_up_relationship_parent.rb +41 -0
  15. data/lib/inttegro/{checkout/invoice_view_format_receipt.rb → app/lookup_capabilities_request.rb} +4 -10
  16. data/lib/inttegro/app/pending_review_capability.rb +43 -0
  17. data/lib/inttegro/app/pending_review_capability_status.rb +25 -0
  18. data/lib/inttegro/app/pending_review_capability_status_reason.rb +34 -0
  19. data/lib/inttegro/app/relationship.rb +7 -63
  20. data/lib/inttegro/app/relationship_parent.rb +41 -0
  21. data/lib/inttegro/app/restricted_capability.rb +51 -0
  22. data/lib/inttegro/app/restricted_capability_status.rb +25 -0
  23. data/lib/inttegro/app/restricted_capability_status_reason.rb +34 -0
  24. data/lib/inttegro/app/updated.rb +10 -0
  25. data/lib/inttegro/balance/currency_snapshot.rb +11 -2
  26. data/lib/inttegro/balance/currency_snapshot_refund.rb +1 -1
  27. data/lib/inttegro/balance/currency_snapshot_reserved.rb +2 -1
  28. data/lib/inttegro/balance/holds.rb +43 -0
  29. data/lib/inttegro/balance/holds_payout.rb +27 -0
  30. data/lib/inttegro/balance/holds_refund.rb +27 -0
  31. data/lib/inttegro/checkout/invoice_view_format.rb +0 -8
  32. data/lib/inttegro/financial_account/compact.rb +5 -7
  33. data/lib/inttegro/financial_account/connected.rb +5 -7
  34. data/lib/inttegro/financial_account/created.rb +5 -7
  35. data/lib/inttegro/financial_account/details.rb +5 -7
  36. data/lib/inttegro/financial_account/financial_account.rb +5 -7
  37. data/lib/inttegro/financial_account/updated.rb +5 -7
  38. data/lib/inttegro/generated/enums.rb +8 -0
  39. data/lib/inttegro/generated/models.rb +21 -3
  40. data/lib/inttegro/generated/operations.rb +3 -0
  41. data/lib/inttegro/models.rb +1 -0
  42. data/lib/inttegro/order/invoice_format.rb +0 -8
  43. data/lib/inttegro/order/{receipt_document_format.rb → receipt.rb} +15 -7
  44. data/lib/inttegro/order/receipt_format.rb +35 -0
  45. data/lib/inttegro/payment/payment.rb +8 -0
  46. data/lib/inttegro/payout/amount_limits.rb +35 -0
  47. data/lib/inttegro/payout/balance_transaction.rb +11 -1
  48. data/lib/inttegro/payout/balance_transaction_status.rb +31 -0
  49. data/lib/inttegro/payout/cancellation.rb +42 -0
  50. data/lib/inttegro/payout/cancellation_reason.rb +30 -0
  51. data/lib/inttegro/payout/error.rb +1 -1
  52. data/lib/inttegro/payout/failure.rb +43 -0
  53. data/lib/inttegro/payout/failure_reason.rb +33 -0
  54. data/lib/inttegro/payout/payout.rb +19 -2
  55. data/lib/inttegro/payout/settings_limits.rb +28 -0
  56. data/lib/inttegro/payout/settings_lookup.rb +8 -0
  57. data/lib/inttegro/payout/settings_mutation.rb +8 -0
  58. data/lib/inttegro/payout/status.rb +2 -2
  59. data/lib/inttegro/resources/apps.rb +12 -0
  60. data/lib/inttegro/version.rb +1 -1
  61. data/rbi/inttegro/generated.rbi +3 -0
  62. metadata +32 -5
  63. data/lib/inttegro/app/relationship_policy.rb +0 -43
@@ -5,12 +5,12 @@
5
5
 
6
6
  require_relative "base"
7
7
  require_relative "relationship_kind"
8
- require_relative "relationship_policy"
8
+ require_relative "relationship_parent"
9
9
  require_relative "relationship_status"
10
10
 
11
11
  module Inttegro
12
12
  class Application
13
- # Relationship receipt for the created child app.
13
+ # Identifies the created app's direct placement relationship.
14
14
  #
15
15
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
16
16
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -30,11 +30,11 @@ module Inttegro
30
30
  # Required in the API payload. Wire name: `kind`.
31
31
  # @return [Inttegro::Application::RelationshipKind]
32
32
  #
33
- # @!attribute [r] policy_version
34
- # Value of the `policy_version` field in the Inttegro API payload.
33
+ # @!attribute [r] parent
34
+ # Application that directly contains the created app.
35
35
  #
36
- # Required in the API payload. Wire name: `policy_version`.
37
- # @return [String]
36
+ # Required in the API payload. Wire name: `parent`.
37
+ # @return [Inttegro::Application::RelationshipParent]
38
38
  #
39
39
  # @!attribute [r] status
40
40
  # Value of the `status` field in the Inttegro API payload.
@@ -42,54 +42,6 @@ module Inttegro
42
42
  # Required in the API payload. Wire name: `status`.
43
43
  # @return [Inttegro::Application::RelationshipStatus]
44
44
  #
45
- # @!attribute [r] actor_app_id
46
- # Value of the `actor_app_id` field in the Inttegro API payload.
47
- #
48
- # Required in the API payload. Wire name: `actor_app_id`.
49
- # @return [String]
50
- #
51
- # @!attribute [r] creator_app_id
52
- # Value of the `creator_app_id` field in the Inttegro API payload.
53
- #
54
- # Required in the API payload. Wire name: `creator_app_id`.
55
- # @return [String]
56
- #
57
- # @!attribute [r] placement_parent_app_id
58
- # Value of the `placement_parent_app_id` field in the Inttegro API payload.
59
- #
60
- # Required in the API payload. Wire name: `placement_parent_app_id`.
61
- # @return [String]
62
- #
63
- # @!attribute [r] subject_app_id
64
- # Value of the `subject_app_id` field in the Inttegro API payload.
65
- #
66
- # Required in the API payload. Wire name: `subject_app_id`.
67
- # @return [String]
68
- #
69
- # @!attribute [r] child_app_id
70
- # Value of the `child_app_id` field in the Inttegro API payload.
71
- #
72
- # Required in the API payload. Wire name: `child_app_id`.
73
- # @return [String]
74
- #
75
- # @!attribute [r] child_standing
76
- # Value of the `child_standing` field in the Inttegro API payload.
77
- #
78
- # Required in the API payload. Wire name: `child_standing`.
79
- # @return [String]
80
- #
81
- # @!attribute [r] relationship_policy
82
- # Value of the `relationship_policy` field in the Inttegro API payload.
83
- #
84
- # Required in the API payload. Wire name: `relationship_policy`.
85
- # @return [Inttegro::Application::RelationshipPolicy]
86
- #
87
- # @!attribute [r] retained_creator_authority_exists
88
- # Value of the `retained_creator_authority_exists` field in the Inttegro API payload.
89
- #
90
- # Required in the API payload. Wire name: `retained_creator_authority_exists`.
91
- # @return [Boolean]
92
- #
93
45
  # @!attribute [r] created_at
94
46
  # Value of the `created_at` field in the Inttegro API payload.
95
47
  #
@@ -98,16 +50,8 @@ module Inttegro
98
50
  class Relationship < T::Struct
99
51
  const :id, String
100
52
  const :kind, Inttegro::Application::RelationshipKind
101
- const :policy_version, String
53
+ const :parent, Inttegro::Application::RelationshipParent
102
54
  const :status, Inttegro::Application::RelationshipStatus
103
- const :actor_app_id, String
104
- const :creator_app_id, String
105
- const :placement_parent_app_id, String
106
- const :subject_app_id, String
107
- const :child_app_id, String
108
- const :child_standing, String
109
- const :relationship_policy, Inttegro::Application::RelationshipPolicy
110
- const :retained_creator_authority_exists, T::Boolean
111
55
  const :created_at, Time
112
56
  end
113
57
  end
@@ -0,0 +1,41 @@
1
+ # frozen_string_literal: true
2
+ # typed: strict
3
+
4
+ # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
5
+
6
+ require_relative "base"
7
+
8
+ module Inttegro
9
+ class Application
10
+ # Application that directly contains the created app.
11
+ #
12
+ # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
13
+ # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
14
+ # field names and serialized enum values.
15
+ #
16
+ # @api public
17
+ #
18
+ # @!attribute [r] id
19
+ # Value of the `id` field in the Inttegro API payload.
20
+ #
21
+ # Required in the API payload. Wire name: `id`.
22
+ # @return [String]
23
+ #
24
+ # @!attribute [r] name
25
+ # Value of the `name` field in the Inttegro API payload.
26
+ #
27
+ # Required in the API payload. Wire name: `name`.
28
+ # @return [String]
29
+ #
30
+ # @!attribute [r] alias
31
+ # Value of the `alias` field in the Inttegro API payload.
32
+ #
33
+ # Optional in the API payload; omitted values default to `nil`. Wire name: `alias`.
34
+ # @return [String, nil]
35
+ class RelationshipParent < T::Struct
36
+ const :id, String
37
+ const :name, String
38
+ const :alias, T.nilable(String), default: nil
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+ # typed: strict
3
+
4
+ # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
5
+
6
+ require_relative "base"
7
+ require_relative "capability_requirements"
8
+ require_relative "restricted_capability_status"
9
+ require_relative "restricted_capability_status_reason"
10
+
11
+ module Inttegro
12
+ class Application
13
+ # Typed representation of the restricted capability object in the Inttegro API.
14
+ #
15
+ # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
16
+ # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
17
+ # field names and serialized enum values.
18
+ #
19
+ # @api public
20
+ #
21
+ # @!attribute [r] status
22
+ # Value of the `status` field in the Inttegro API payload.
23
+ #
24
+ # Required in the API payload. Wire name: `status`.
25
+ # @return [Inttegro::Application::RestrictedCapabilityStatus]
26
+ #
27
+ # @!attribute [r] status_reason
28
+ # Value of the `status_reason` field in the Inttegro API payload.
29
+ #
30
+ # Required in the API payload. Wire name: `status_reason`.
31
+ # @return [Inttegro::Application::RestrictedCapabilityStatusReason]
32
+ #
33
+ # @!attribute [r] status_changed_at
34
+ # Value of the `status_changed_at` field in the Inttegro API payload.
35
+ #
36
+ # Required in the API payload. Wire name: `status_changed_at`.
37
+ # @return [Time]
38
+ #
39
+ # @!attribute [r] requirements
40
+ # Value of the `requirements` field in the Inttegro API payload.
41
+ #
42
+ # Required in the API payload. Wire name: `requirements`.
43
+ # @return [Inttegro::Application::CapabilityRequirements]
44
+ class RestrictedCapability < T::Struct
45
+ const :status, Inttegro::Application::RestrictedCapabilityStatus
46
+ const :status_reason, Inttegro::Application::RestrictedCapabilityStatusReason
47
+ const :status_changed_at, Time
48
+ const :requirements, Inttegro::Application::CapabilityRequirements
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+ # typed: strict
3
+
4
+ # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
5
+
6
+ require_relative "base"
7
+
8
+ module Inttegro
9
+ class Application
10
+ # String-backed values accepted by the Inttegro API for
11
+ # Inttegro::Application::RestrictedCapabilityStatus.
12
+ #
13
+ # Use the constants below when constructing a request. `#serialize` returns the documented
14
+ # string wire value received from or sent to the API.
15
+ #
16
+ # @api public
17
+ class RestrictedCapabilityStatus < T::Enum
18
+ enums do
19
+ # Serialized wire value: `restricted`.
20
+ # @return [Inttegro::Application::RestrictedCapabilityStatus]
21
+ RESTRICTED = new("restricted")
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+ # typed: strict
3
+
4
+ # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
5
+
6
+ require_relative "base"
7
+
8
+ module Inttegro
9
+ class Application
10
+ # String-backed values accepted by the Inttegro API for
11
+ # Inttegro::Application::RestrictedCapabilityStatusReason.
12
+ #
13
+ # Use the constants below when constructing a request. `#serialize` returns the documented
14
+ # string wire value received from or sent to the API.
15
+ #
16
+ # @api public
17
+ class RestrictedCapabilityStatusReason < T::Enum
18
+ enums do
19
+ # Serialized wire value: `setup_incomplete`.
20
+ # @return [Inttegro::Application::RestrictedCapabilityStatusReason]
21
+ SETUP_INCOMPLETE = new("setup_incomplete")
22
+ # Serialized wire value: `account_under_review`.
23
+ # @return [Inttegro::Application::RestrictedCapabilityStatusReason]
24
+ ACCOUNT_UNDER_REVIEW = new("account_under_review")
25
+ # Serialized wire value: `account_restricted`.
26
+ # @return [Inttegro::Application::RestrictedCapabilityStatusReason]
27
+ ACCOUNT_RESTRICTED = new("account_restricted")
28
+ # Serialized wire value: `account_inactive`.
29
+ # @return [Inttegro::Application::RestrictedCapabilityStatusReason]
30
+ ACCOUNT_INACTIVE = new("account_inactive")
31
+ end
32
+ end
33
+ end
34
+ end
@@ -4,6 +4,7 @@
4
4
  # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
5
5
 
6
6
  require_relative "base"
7
+ require_relative "capability_projection"
7
8
 
8
9
  module Inttegro
9
10
  class Application
@@ -50,6 +51,14 @@ module Inttegro
50
51
  #
51
52
  # Optional in the API payload; omitted values default to `nil`. Wire name: `updated_at`.
52
53
  # @return [Time, nil]
54
+ #
55
+ # @!attribute [r] capabilities
56
+ # Public capability states currently available to the application. Newly created applications
57
+ # can return an empty object until capabilities become available. New capability keys may
58
+ # appear over time.
59
+ #
60
+ # Required in the API payload. Wire name: `capabilities`.
61
+ # @return [Inttegro::Application::CapabilityProjection]
53
62
  class Updated < T::Struct
54
63
  const :id, String
55
64
  const :name, String
@@ -57,6 +66,7 @@ module Inttegro
57
66
  const :description, T.nilable(String), default: nil
58
67
  const :created_at, Time
59
68
  const :updated_at, T.nilable(Time), default: nil
69
+ const :capabilities, Inttegro::Application::CapabilityProjection
60
70
  end
61
71
  end
62
72
  end
@@ -6,6 +6,7 @@
6
6
  require_relative "base"
7
7
  require_relative "currency_snapshot_refund"
8
8
  require_relative "currency_snapshot_reserved"
9
+ require_relative "holds"
9
10
  require_relative "value"
10
11
 
11
12
  module Inttegro
@@ -24,6 +25,12 @@ module Inttegro
24
25
  # Required in the API payload. Wire name: `available`.
25
26
  # @return [Inttegro::Balance::Value]
26
27
  #
28
+ # @!attribute [r] held
29
+ # Live operational commitments read from the canonical balance position.
30
+ #
31
+ # Required in the API payload. Wire name: `held`.
32
+ # @return [Inttegro::Balance::Holds]
33
+ #
27
34
  # @!attribute [r] includes_transactions_before
28
35
  # The snapshot includes transactions created before this timestamp
29
36
  #
@@ -37,18 +44,20 @@ module Inttegro
37
44
  # @return [Inttegro::Balance::Value]
38
45
  #
39
46
  # @!attribute [r] refund
40
- # Funds assigned to refund activity at the snapshot cutoff
47
+ # Funds intentionally earmarked for future refund obligations at the snapshot cutoff
41
48
  #
42
49
  # Required in the API payload. Wire name: `refund`.
43
50
  # @return [Inttegro::Balance::CurrencySnapshotRefund]
44
51
  #
45
52
  # @!attribute [r] reserved
46
- # Funds held back from payout at the snapshot cutoff
53
+ # Funds intentionally reserved for policy, risk, or remediation purposes at the snapshot
54
+ # cutoff
47
55
  #
48
56
  # Required in the API payload. Wire name: `reserved`.
49
57
  # @return [Inttegro::Balance::CurrencySnapshotReserved]
50
58
  class CurrencySnapshot < T::Struct
51
59
  const :available, Inttegro::Balance::Value
60
+ const :held, Inttegro::Balance::Holds
52
61
  const :includes_transactions_before, Time
53
62
  const :pending, Inttegro::Balance::Value
54
63
  const :refund, Inttegro::Balance::CurrencySnapshotRefund
@@ -7,7 +7,7 @@ require_relative "base"
7
7
 
8
8
  module Inttegro
9
9
  module Balance
10
- # Funds assigned to refund activity at the snapshot cutoff
10
+ # Funds intentionally earmarked for future refund obligations at the snapshot cutoff
11
11
  #
12
12
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
13
13
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -7,7 +7,8 @@ require_relative "base"
7
7
 
8
8
  module Inttegro
9
9
  module Balance
10
- # Funds held back from payout at the snapshot cutoff
10
+ # Funds intentionally reserved for policy, risk, or remediation purposes at the snapshot
11
+ # cutoff
11
12
  #
12
13
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
13
14
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -0,0 +1,43 @@
1
+ # frozen_string_literal: true
2
+ # typed: strict
3
+
4
+ # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
5
+
6
+ require_relative "base"
7
+ require_relative "holds_payout"
8
+ require_relative "holds_refund"
9
+
10
+ module Inttegro
11
+ module Balance
12
+ # Live operational commitments read from the canonical balance position.
13
+ #
14
+ # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
15
+ # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
16
+ # field names and serialized enum values.
17
+ #
18
+ # @api public
19
+ #
20
+ # @!attribute [r] as_of
21
+ # When these strongly consistent hold amounts were read.
22
+ #
23
+ # Required in the API payload. Wire name: `as_of`.
24
+ # @return [Time]
25
+ #
26
+ # @!attribute [r] payout
27
+ # Funds committed to in-flight or unresolved payouts.
28
+ #
29
+ # Required in the API payload. Wire name: `payout`.
30
+ # @return [Inttegro::Balance::HoldsPayout]
31
+ #
32
+ # @!attribute [r] refund
33
+ # Funds committed to in-flight or unresolved refunds.
34
+ #
35
+ # Required in the API payload. Wire name: `refund`.
36
+ # @return [Inttegro::Balance::HoldsRefund]
37
+ class Holds < T::Struct
38
+ const :as_of, Time
39
+ const :payout, Inttegro::Balance::HoldsPayout
40
+ const :refund, Inttegro::Balance::HoldsRefund
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+ # typed: strict
3
+
4
+ # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
5
+
6
+ require_relative "base"
7
+
8
+ module Inttegro
9
+ module Balance
10
+ # Funds committed to in-flight or unresolved payouts.
11
+ #
12
+ # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
13
+ # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
14
+ # field names and serialized enum values.
15
+ #
16
+ # @api public
17
+ #
18
+ # @!attribute [r] amount
19
+ # Amount in the currency's smallest unit
20
+ #
21
+ # Required in the API payload. Wire name: `amount`.
22
+ # @return [Integer]
23
+ class HoldsPayout < T::Struct
24
+ const :amount, Integer
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+ # typed: strict
3
+
4
+ # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
5
+
6
+ require_relative "base"
7
+
8
+ module Inttegro
9
+ module Balance
10
+ # Funds committed to in-flight or unresolved refunds.
11
+ #
12
+ # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
13
+ # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
14
+ # field names and serialized enum values.
15
+ #
16
+ # @api public
17
+ #
18
+ # @!attribute [r] amount
19
+ # Amount in the currency's smallest unit
20
+ #
21
+ # Required in the API payload. Wire name: `amount`.
22
+ # @return [Integer]
23
+ class HoldsRefund < T::Struct
24
+ const :amount, Integer
25
+ end
26
+ end
27
+ end
@@ -5,7 +5,6 @@
5
5
 
6
6
  require_relative "base"
7
7
  require_relative "invoice_view_format_pdf"
8
- require_relative "invoice_view_format_receipt"
9
8
  require_relative "invoice_view_format_web"
10
9
 
11
10
  module Inttegro
@@ -29,16 +28,9 @@ module Inttegro
29
28
  #
30
29
  # Optional in the API payload; omitted values default to `nil`. Wire name: `pdf`.
31
30
  # @return [Inttegro::Checkout::InvoiceViewFormatPdf, nil]
32
- #
33
- # @!attribute [r] receipt
34
- # Value of the `receipt` field in the Inttegro API payload.
35
- #
36
- # Optional in the API payload; omitted values default to `nil`. Wire name: `receipt`.
37
- # @return [Inttegro::Checkout::InvoiceViewFormatReceipt, nil]
38
31
  class InvoiceViewFormat < T::Struct
39
32
  const :web, T.nilable(Inttegro::Checkout::InvoiceViewFormatWeb), default: nil
40
33
  const :pdf, T.nilable(Inttegro::Checkout::InvoiceViewFormatPdf), default: nil
41
- const :receipt, T.nilable(Inttegro::Checkout::InvoiceViewFormatReceipt), default: nil
42
34
  end
43
35
  end
44
36
  end
@@ -41,13 +41,11 @@ module Inttegro
41
41
  # @return [Time, nil]
42
42
  #
43
43
  # @!attribute [r] fingerprint
44
- # Application-scoped value for recognizing the same underlying financial account within the
45
- # authenticated application. Matching nonempty fingerprints can be used to detect duplicate
46
- # connections. Compare fingerprints only within the same application. Omitted when reliable
47
- # fingerprint material is unavailable.
44
+ # A stable identifier for the underlying financial account within your application. Use it to
45
+ # recognize when the same account has been connected more than once.
48
46
  #
49
- # Optional in the API payload; omitted values default to `nil`. Wire name: `fingerprint`.
50
- # @return [String, nil]
47
+ # Required in the API payload. Wire name: `fingerprint`.
48
+ # @return [String]
51
49
  #
52
50
  # @!attribute [r] id
53
51
  # Value of the `id` field in the Inttegro API payload.
@@ -71,7 +69,7 @@ module Inttegro
71
69
  const :currency, String
72
70
  const :description, T.nilable(String), default: nil
73
71
  const :disconnected_at, T.nilable(Time), default: nil
74
- const :fingerprint, T.nilable(String), default: nil
72
+ const :fingerprint, String
75
73
  const :id, String
76
74
  const :label, T.nilable(String), default: nil
77
75
  const :type, Inttegro::FinancialAccount::Type
@@ -58,13 +58,11 @@ module Inttegro
58
58
  # @return [String, nil]
59
59
  #
60
60
  # @!attribute [r] fingerprint
61
- # Application-scoped value for recognizing the same underlying financial account within the
62
- # authenticated application. Matching nonempty fingerprints can be used to detect duplicate
63
- # connections. Compare fingerprints only within the same application. Omitted when reliable
64
- # fingerprint material is unavailable.
61
+ # A stable identifier for the underlying financial account within your application. Use it to
62
+ # recognize when the same account has been connected more than once.
65
63
  #
66
- # Optional in the API payload; omitted values default to `nil`. Wire name: `fingerprint`.
67
- # @return [String, nil]
64
+ # Required in the API payload. Wire name: `fingerprint`.
65
+ # @return [String]
68
66
  #
69
67
  # @!attribute [r] id
70
68
  # Value of the `id` field in the Inttegro API payload.
@@ -150,7 +148,7 @@ module Inttegro
150
148
  const :currency, String
151
149
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
152
150
  const :description, T.nilable(String), default: nil
153
- const :fingerprint, T.nilable(String), default: nil
151
+ const :fingerprint, String
154
152
  const :id, String
155
153
  const :institution, T.nilable(Inttegro::Shared::FinancialInstitution), default: nil
156
154
  const :label, T.nilable(String), default: nil
@@ -57,13 +57,11 @@ module Inttegro
57
57
  # @return [String, nil]
58
58
  #
59
59
  # @!attribute [r] fingerprint
60
- # Application-scoped value for recognizing the same underlying financial account within the
61
- # authenticated application. Matching nonempty fingerprints can be used to detect duplicate
62
- # connections. Compare fingerprints only within the same application. Omitted when reliable
63
- # fingerprint material is unavailable.
60
+ # A stable identifier for the underlying financial account within your application. Use it to
61
+ # recognize when the same account has been connected more than once.
64
62
  #
65
- # Optional in the API payload; omitted values default to `nil`. Wire name: `fingerprint`.
66
- # @return [String, nil]
63
+ # Required in the API payload. Wire name: `fingerprint`.
64
+ # @return [String]
67
65
  #
68
66
  # @!attribute [r] id
69
67
  # Value of the `id` field in the Inttegro API payload.
@@ -142,7 +140,7 @@ module Inttegro
142
140
  const :currency, String
143
141
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
144
142
  const :description, T.nilable(String), default: nil
145
- const :fingerprint, T.nilable(String), default: nil
143
+ const :fingerprint, String
146
144
  const :id, String
147
145
  const :institution, T.nilable(Inttegro::Shared::FinancialInstitution), default: nil
148
146
  const :label, T.nilable(String), default: nil
@@ -54,13 +54,11 @@ module Inttegro
54
54
  # @return [String, nil]
55
55
  #
56
56
  # @!attribute [r] fingerprint
57
- # Application-scoped value for recognizing the same underlying financial account within the
58
- # authenticated application. Matching nonempty fingerprints can be used to detect duplicate
59
- # connections. Compare fingerprints only within the same application. Omitted when reliable
60
- # fingerprint material is unavailable.
57
+ # A stable identifier for the underlying financial account within your application. Use it to
58
+ # recognize when the same account has been connected more than once.
61
59
  #
62
- # Optional in the API payload; omitted values default to `nil`. Wire name: `fingerprint`.
63
- # @return [String, nil]
60
+ # Required in the API payload. Wire name: `fingerprint`.
61
+ # @return [String]
64
62
  #
65
63
  # @!attribute [r] id
66
64
  # Value of the `id` field in the Inttegro API payload.
@@ -121,7 +119,7 @@ module Inttegro
121
119
  const :currency, String
122
120
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
123
121
  const :description, T.nilable(String), default: nil
124
- const :fingerprint, T.nilable(String), default: nil
122
+ const :fingerprint, String
125
123
  const :id, String
126
124
  const :institution, T.nilable(Inttegro::Shared::FinancialInstitution), default: nil
127
125
  const :label, T.nilable(String), default: nil
@@ -57,13 +57,11 @@ module Inttegro
57
57
  # @return [String, nil]
58
58
  #
59
59
  # @!attribute [r] fingerprint
60
- # Application-scoped value for recognizing the same underlying financial account within the
61
- # authenticated application. Matching nonempty fingerprints can be used to detect duplicate
62
- # connections. Compare fingerprints only within the same application. Omitted when reliable
63
- # fingerprint material is unavailable.
60
+ # A stable identifier for the underlying financial account within your application. Use it to
61
+ # recognize when the same account has been connected more than once.
64
62
  #
65
- # Optional in the API payload; omitted values default to `nil`. Wire name: `fingerprint`.
66
- # @return [String, nil]
63
+ # Required in the API payload. Wire name: `fingerprint`.
64
+ # @return [String]
67
65
  #
68
66
  # @!attribute [r] id
69
67
  # Value of the `id` field in the Inttegro API payload.
@@ -155,7 +153,7 @@ module Inttegro
155
153
  const :currency, String
156
154
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
157
155
  const :description, T.nilable(String), default: nil
158
- const :fingerprint, T.nilable(String), default: nil
156
+ const :fingerprint, String
159
157
  const :id, String
160
158
  const :institution, T.nilable(Inttegro::Shared::FinancialInstitution), default: nil
161
159
  const :label, T.nilable(String), default: nil
@@ -58,13 +58,11 @@ module Inttegro
58
58
  # @return [String, nil]
59
59
  #
60
60
  # @!attribute [r] fingerprint
61
- # Application-scoped value for recognizing the same underlying financial account within the
62
- # authenticated application. Matching nonempty fingerprints can be used to detect duplicate
63
- # connections. Compare fingerprints only within the same application. Omitted when reliable
64
- # fingerprint material is unavailable.
61
+ # A stable identifier for the underlying financial account within your application. Use it to
62
+ # recognize when the same account has been connected more than once.
65
63
  #
66
- # Optional in the API payload; omitted values default to `nil`. Wire name: `fingerprint`.
67
- # @return [String, nil]
64
+ # Required in the API payload. Wire name: `fingerprint`.
65
+ # @return [String]
68
66
  #
69
67
  # @!attribute [r] id
70
68
  # Value of the `id` field in the Inttegro API payload.
@@ -156,7 +154,7 @@ module Inttegro
156
154
  const :currency, String
157
155
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
158
156
  const :description, T.nilable(String), default: nil
159
- const :fingerprint, T.nilable(String), default: nil
157
+ const :fingerprint, String
160
158
  const :id, String
161
159
  const :institution, T.nilable(Inttegro::Shared::FinancialInstitution), default: nil
162
160
  const :label, T.nilable(String), default: nil