inttegro 6.0.1 → 8.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 (107) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +2 -2
  4. data/SECURITY.md +1 -1
  5. data/lib/inttegro/api_response.rb +41 -0
  6. data/lib/inttegro/chime/chime.rb +3 -2
  7. data/lib/inttegro/chime/send_request.rb +3 -2
  8. data/lib/inttegro/custom_data.rb +132 -0
  9. data/lib/inttegro/customer/create_request.rb +3 -2
  10. data/lib/inttegro/customer/customer.rb +3 -2
  11. data/lib/inttegro/customer/data.rb +3 -2
  12. data/lib/inttegro/customer/update_request.rb +3 -2
  13. data/lib/inttegro/file/file.rb +3 -2
  14. data/lib/inttegro/file_link/create_request.rb +3 -2
  15. data/lib/inttegro/file_link/file_link.rb +3 -2
  16. data/lib/inttegro/financial_account/bank_request.rb +3 -2
  17. data/lib/inttegro/financial_account/connected.rb +3 -2
  18. data/lib/inttegro/financial_account/created.rb +3 -2
  19. data/lib/inttegro/financial_account/details.rb +3 -2
  20. data/lib/inttegro/financial_account/dosh_request.rb +3 -2
  21. data/lib/inttegro/financial_account/financial_account.rb +3 -2
  22. data/lib/inttegro/financial_account/request_base.rb +3 -2
  23. data/lib/inttegro/financial_account/update_request.rb +3 -2
  24. data/lib/inttegro/financial_account/updated.rb +3 -2
  25. data/lib/inttegro/financial_account/wallet_request.rb +3 -2
  26. data/lib/inttegro/financial_account/wire_page_accounts_item.rb +3 -2
  27. data/lib/inttegro/generated/enums.rb +5 -1
  28. data/lib/inttegro/generated/models.rb +22 -17
  29. data/lib/inttegro/generated/operations.rb +6 -6
  30. data/lib/inttegro/http_client.rb +65 -1
  31. data/lib/inttegro/model_serialization.rb +30 -1
  32. data/lib/inttegro/order/create_existing_customer.rb +3 -2
  33. data/lib/inttegro/order/create_new_customer.rb +3 -2
  34. data/lib/inttegro/order/order.rb +3 -2
  35. data/lib/inttegro/order/product_line_item_product.rb +3 -2
  36. data/lib/inttegro/order/update_request.rb +3 -2
  37. data/lib/inttegro/payment_method/payment_method.rb +14 -2
  38. data/lib/inttegro/payment_method/tokenize_base.rb +3 -2
  39. data/lib/inttegro/payment_method/tokenize_mobile_money_request.rb +3 -2
  40. data/lib/inttegro/payment_method/update_request.rb +3 -2
  41. data/lib/inttegro/payout/cancel_request.rb +2 -2
  42. data/lib/inttegro/payout/{lookup_response.rb → destinations.rb} +8 -8
  43. data/lib/inttegro/payout/disable_automatic_response.rb +1 -1
  44. data/lib/inttegro/payout/error.rb +5 -5
  45. data/lib/inttegro/payout/lookup_request.rb +2 -2
  46. data/lib/inttegro/payout/page.rb +3 -3
  47. data/lib/inttegro/payout/page_request.rb +3 -3
  48. data/lib/inttegro/payout/page_response.rb +2 -2
  49. data/lib/inttegro/payout/payout.rb +4 -3
  50. data/lib/inttegro/payout/{cancel_response.rb → response.rb} +2 -2
  51. data/lib/inttegro/payout/set_destinations_request.rb +5 -4
  52. data/lib/inttegro/payout/settings_lookup.rb +5 -4
  53. data/lib/inttegro/payout/{get_settings_response.rb → settings_lookup_response.rb} +2 -2
  54. data/lib/inttegro/payout/settings_lookup_schedule.rb +2 -2
  55. data/lib/inttegro/payout/settings_lookup_schedule_aging_spec.rb +4 -4
  56. data/lib/inttegro/payout/settings_mutation.rb +12 -4
  57. data/lib/inttegro/payout/{set_destinations_response.rb → settings_mutation_response.rb} +2 -2
  58. data/lib/inttegro/payout/settings_mutation_schedule.rb +2 -2
  59. data/lib/inttegro/payout/settings_mutation_schedule_spec.rb +1 -1
  60. data/lib/inttegro/price/embedded_product.rb +3 -2
  61. data/lib/inttegro/product/create_request.rb +3 -2
  62. data/lib/inttegro/product/inline_details.rb +3 -2
  63. data/lib/inttegro/product/product.rb +3 -2
  64. data/lib/inttegro/product/update_request.rb +3 -2
  65. data/lib/inttegro/product/updated.rb +3 -2
  66. data/lib/inttegro/purchase_intent/product.rb +3 -2
  67. data/lib/inttegro/purchase_intent/purchase_intent.rb +0 -8
  68. data/lib/inttegro/refund/cancel_request.rb +7 -0
  69. data/lib/inttegro/refund/create_request.rb +3 -2
  70. data/lib/inttegro/refund/failure.rb +45 -0
  71. data/lib/inttegro/refund/failure_reason.rb +49 -0
  72. data/lib/inttegro/refund/offline_settlement.rb +28 -0
  73. data/lib/inttegro/refund/offline_settlement_type.rb +24 -0
  74. data/lib/inttegro/refund/payment_method_settlement.rb +37 -0
  75. data/lib/inttegro/refund/payment_method_settlement_type.rb +24 -0
  76. data/lib/inttegro/refund/refund.rb +35 -2
  77. data/lib/inttegro/refund/settlement.rb +19 -0
  78. data/lib/inttegro/refund/settlement_bank_account_payment_method.rb +44 -0
  79. data/lib/inttegro/refund/settlement_bank_account_payment_method_bank_account.rb +37 -0
  80. data/lib/inttegro/refund/settlement_bank_account_payment_method_bank_account_ghana_bank_account.rb +35 -0
  81. data/lib/inttegro/refund/settlement_bank_account_payment_method_type.rb +25 -0
  82. data/lib/inttegro/refund/settlement_mobile_money_payment_method.rb +44 -0
  83. data/lib/inttegro/refund/settlement_mobile_money_payment_method_mobile_money.rb +43 -0
  84. data/lib/inttegro/refund/settlement_mobile_money_payment_method_type.rb +25 -0
  85. data/lib/inttegro/refund/settlement_payment_method.rb +19 -0
  86. data/lib/inttegro/resources/orders.rb +8 -0
  87. data/lib/inttegro/resources/payouts.rb +15 -32
  88. data/lib/inttegro/resources/refunds.rb +5 -2
  89. data/lib/inttegro/schedule/payout_request.rb +5 -5
  90. data/lib/inttegro/shared/fee_details.rb +3 -2
  91. data/lib/inttegro/shared/invoice_settings.rb +3 -2
  92. data/lib/inttegro/shared/response_meta.rb +35 -0
  93. data/lib/inttegro/shared/shipping_details.rb +3 -2
  94. data/lib/inttegro/upload_request/create_request.rb +3 -2
  95. data/lib/inttegro/upload_request/details.rb +3 -2
  96. data/lib/inttegro/upload_request/upload_request.rb +3 -2
  97. data/lib/inttegro/version.rb +1 -1
  98. data/lib/inttegro.rb +2 -0
  99. data/rbi/inttegro/generated.rbi +11 -8
  100. metadata +27 -16
  101. data/lib/inttegro/payout/enable_automatic_response.rb +0 -28
  102. data/lib/inttegro/purchase_intent/activity.rb +0 -122
  103. data/lib/inttegro/purchase_intent/activity_attribution.rb +0 -83
  104. data/lib/inttegro/purchase_intent/activity_log.rb +0 -28
  105. data/lib/inttegro/purchase_intent/activity_type.rb +0 -37
  106. data/lib/inttegro/purchase_intent/activity_visitor.rb +0 -97
  107. data/lib/inttegro/schedule/payout_response.rb +0 -28
@@ -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 "../custom_data"
7
8
  require_relative "update_request_owner"
8
9
 
9
10
  module Inttegro
@@ -27,7 +28,7 @@ module Inttegro
27
28
  # serialized to a string.
28
29
  #
29
30
  # Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
30
- # @return [Hash{String => Object}, nil]
31
+ # @return [Inttegro::CustomDataPatch, nil]
31
32
  #
32
33
  # @!attribute [r] active
33
34
  # Set to `true` to activate the payment method or `false` to mark it inactive.
@@ -48,7 +49,7 @@ module Inttegro
48
49
  # @return [Inttegro::PaymentMethod::UpdateRequestOwner, nil]
49
50
  class UpdateRequest < T::Struct
50
51
  const :payment_method_id, String
51
- const :custom_data, T.nilable(T::Hash[String, Object]), default: nil
52
+ const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
52
53
  const :active, T.nilable(T::Boolean), default: nil
53
54
  const :archived, T.nilable(T::Boolean), default: nil
54
55
  const :owner, T.nilable(Inttegro::PaymentMethod::UpdateRequestOwner), default: nil
@@ -7,7 +7,7 @@ require_relative "base"
7
7
 
8
8
  module Inttegro
9
9
  class Payout
10
- # Typed representation of the cancel request object in the Inttegro API.
10
+ # Parameters for canceling a scheduled payout.
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
@@ -16,7 +16,7 @@ module Inttegro
16
16
  # @api public
17
17
  #
18
18
  # @!attribute [r] payout_id
19
- # Scheduled payout ID
19
+ # Scheduled payout identifier.
20
20
  #
21
21
  # Required in the API payload. Wire name: `payout_id`.
22
22
  # @return [String]
@@ -4,11 +4,10 @@
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 "payout"
8
7
 
9
8
  module Inttegro
10
9
  class Payout
11
- # Typed representation of the lookup response object in the Inttegro API.
10
+ # Supported currency-to-financial-account destination assignments.
12
11
  #
13
12
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
14
13
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -16,13 +15,14 @@ module Inttegro
16
15
  #
17
16
  # @api public
18
17
  #
19
- # @!attribute [r] payout
20
- # A payout scheduled from your Inttegro balance to a destination financial account
18
+ # @!attribute [r] ghs
19
+ # Financial account that receives Ghana cedi payouts. Send an empty string to remove the
20
+ # assignment.
21
21
  #
22
- # Optional in the API payload; omitted values default to `nil`. Wire name: `payout`.
23
- # @return [Inttegro::Payout, nil]
24
- class LookupResponse < T::Struct
25
- const :payout, T.nilable(Inttegro::Payout), default: nil
22
+ # Optional in the API payload; omitted values default to `nil`. Wire name: `ghs`.
23
+ # @return [String, nil]
24
+ class Destinations < T::Struct
25
+ const :ghs, T.nilable(String), default: nil
26
26
  end
27
27
  end
28
28
  end
@@ -8,7 +8,7 @@ require_relative "settings_mutation"
8
8
 
9
9
  module Inttegro
10
10
  class Payout
11
- # Typed representation of the disable automatic response object in the Inttegro API.
11
+ # Response envelope containing updated payout settings.
12
12
  #
13
13
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
14
14
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -7,7 +7,7 @@ require_relative "base"
7
7
 
8
8
  module Inttegro
9
9
  class Payout
10
- # Public failure details when execution fails
10
+ # Public failure details returned when payout execution fails.
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
@@ -16,25 +16,25 @@ module Inttegro
16
16
  # @api public
17
17
  #
18
18
  # @!attribute [r] cause
19
- # Value of the `cause` field in the Inttegro API payload.
19
+ # Public explanation of the underlying failure cause.
20
20
  #
21
21
  # Required in the API payload. Wire name: `cause`.
22
22
  # @return [String]
23
23
  #
24
24
  # @!attribute [r] message
25
- # Value of the `message` field in the Inttegro API payload.
25
+ # Human-readable failure message.
26
26
  #
27
27
  # Required in the API payload. Wire name: `message`.
28
28
  # @return [String]
29
29
  #
30
30
  # @!attribute [r] occurred_at
31
- # Value of the `occurred_at` field in the Inttegro API payload.
31
+ # When the failure occurred.
32
32
  #
33
33
  # Required in the API payload. Wire name: `occurred_at`.
34
34
  # @return [Time]
35
35
  #
36
36
  # @!attribute [r] type
37
- # Value of the `type` field in the Inttegro API payload.
37
+ # Stable machine-readable failure category.
38
38
  #
39
39
  # Required in the API payload. Wire name: `type`.
40
40
  # @return [String]
@@ -7,7 +7,7 @@ require_relative "base"
7
7
 
8
8
  module Inttegro
9
9
  class Payout
10
- # Typed representation of the lookup request object in the Inttegro API.
10
+ # Parameters for retrieving a payout.
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
@@ -16,7 +16,7 @@ module Inttegro
16
16
  # @api public
17
17
  #
18
18
  # @!attribute [r] payout_id
19
- # Payout identifier returned when the payout was created
19
+ # Payout identifier returned when the payout was created.
20
20
  #
21
21
  # Required in the API payload. Wire name: `payout_id`.
22
22
  # @return [String]
@@ -8,7 +8,7 @@ require_relative "payout"
8
8
 
9
9
  module Inttegro
10
10
  class Payout
11
- # Typed representation of the page object in the Inttegro API.
11
+ # A page of payouts ordered from newest to oldest.
12
12
  #
13
13
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
14
14
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -17,13 +17,13 @@ module Inttegro
17
17
  # @api public
18
18
  #
19
19
  # @!attribute [r] number
20
- # Page number returned
20
+ # Page number returned.
21
21
  #
22
22
  # Required in the API payload. Wire name: `number`.
23
23
  # @return [Integer]
24
24
  #
25
25
  # @!attribute [r] size
26
- # Number of payouts returned
26
+ # Number of payouts returned.
27
27
  #
28
28
  # Required in the API payload. Wire name: `size`.
29
29
  # @return [Integer]
@@ -7,7 +7,7 @@ require_relative "base"
7
7
 
8
8
  module Inttegro
9
9
  class Payout
10
- # Typed representation of the page request object in the Inttegro API.
10
+ # Pagination parameters for payouts.
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
@@ -16,13 +16,13 @@ module Inttegro
16
16
  # @api public
17
17
  #
18
18
  # @!attribute [r] page_number
19
- # 1-based page index to fetch (1-10 inclusive)
19
+ # 1-based page index to fetch (1-10 inclusive).
20
20
  #
21
21
  # Required in the API payload. Wire name: `page_number`.
22
22
  # @return [Integer]
23
23
  #
24
24
  # @!attribute [r] page_size
25
- # Maximum number of payouts to return (1-256)
25
+ # Maximum number of payouts to return (1-256).
26
26
  #
27
27
  # Optional in the API payload; omitted values default to `nil`. Wire name: `page_size`.
28
28
  # @return [Integer, nil]
@@ -8,7 +8,7 @@ require_relative "page"
8
8
 
9
9
  module Inttegro
10
10
  class Payout
11
- # Typed representation of the page response object in the Inttegro API.
11
+ # Response envelope containing a page of payouts.
12
12
  #
13
13
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
14
14
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -17,7 +17,7 @@ module Inttegro
17
17
  # @api public
18
18
  #
19
19
  # @!attribute [r] page
20
- # Value of the `page` field in the Inttegro API payload.
20
+ # A page of payouts ordered from newest to oldest.
21
21
  #
22
22
  # Optional in the API payload; omitted values default to `nil`. Wire name: `page`.
23
23
  # @return [Inttegro::Payout::Page, nil]
@@ -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 "../custom_data"
7
8
  require_relative "../money/amount"
8
9
  require_relative "error"
9
10
  require_relative "status"
@@ -40,7 +41,7 @@ module Inttegro
40
41
  # collection rather than a raw map.
41
42
  #
42
43
  # Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
43
- # @return [Hash{String => String}, nil]
44
+ # @return [Inttegro::CustomData, nil]
44
45
  #
45
46
  # @!attribute [r] destination_id
46
47
  # Financial account receiving the funds
@@ -49,7 +50,7 @@ module Inttegro
49
50
  # @return [String]
50
51
  #
51
52
  # @!attribute [r] error
52
- # Public failure details when execution fails
53
+ # Public failure details returned when payout execution fails.
53
54
  #
54
55
  # Optional in the API payload; omitted values default to `nil`. Wire name: `error`.
55
56
  # @return [Inttegro::Payout::Error, nil]
@@ -153,7 +154,7 @@ module Inttegro
153
154
  const :amount, T.nilable(Inttegro::Money::Amount), default: nil
154
155
  const :balance_transactions, T.nilable(T::Array[String]), default: nil
155
156
  const :canceled_at, T.nilable(Time), default: nil
156
- const :custom_data, T.nilable(T::Hash[String, String]), default: nil
157
+ const :custom_data, T.nilable(Inttegro::CustomData), default: nil
157
158
  const :destination_id, String
158
159
  const :error, T.nilable(Inttegro::Payout::Error), default: nil
159
160
  const :execute_after, Time
@@ -8,7 +8,7 @@ require_relative "payout"
8
8
 
9
9
  module Inttegro
10
10
  class Payout
11
- # Typed representation of the cancel response object in the Inttegro API.
11
+ # Response envelope containing a payout.
12
12
  #
13
13
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
14
14
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -21,7 +21,7 @@ module Inttegro
21
21
  #
22
22
  # Optional in the API payload; omitted values default to `nil`. Wire name: `payout`.
23
23
  # @return [Inttegro::Payout, nil]
24
- class CancelResponse < T::Struct
24
+ class Response < T::Struct
25
25
  const :payout, T.nilable(Inttegro::Payout), default: nil
26
26
  end
27
27
  end
@@ -4,10 +4,11 @@
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 "destinations"
7
8
 
8
9
  module Inttegro
9
10
  class Payout
10
- # Typed representation of the set destinations request object in the Inttegro API.
11
+ # Supported payout destination assignments to update.
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
@@ -16,12 +17,12 @@ module Inttegro
16
17
  # @api public
17
18
  #
18
19
  # @!attribute [r] destinations
19
- # Currency-to-financial-account destination assignments.
20
+ # Supported currency-to-financial-account destination assignments.
20
21
  #
21
22
  # Required in the API payload. Wire name: `destinations`.
22
- # @return [Hash{String => String}]
23
+ # @return [Inttegro::Payout::Destinations]
23
24
  class SetDestinationsRequest < T::Struct
24
- const :destinations, T::Hash[String, String]
25
+ const :destinations, Inttegro::Payout::Destinations
25
26
  end
26
27
  end
27
28
  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 "destinations"
7
8
  require_relative "settings_lookup_schedule"
8
9
 
9
10
  module Inttegro
@@ -17,10 +18,10 @@ module Inttegro
17
18
  # @api public
18
19
  #
19
20
  # @!attribute [r] destinations
20
- # Currency-to-financial-account destination assignments.
21
+ # Supported currency-to-financial-account destination assignments.
21
22
  #
22
23
  # Required in the API payload. Wire name: `destinations`.
23
- # @return [Hash{String => String}]
24
+ # @return [Inttegro::Payout::Destinations]
24
25
  #
25
26
  # @!attribute [r] fx_enabled
26
27
  # Present only when foreign exchange is enabled in stored settings
@@ -29,12 +30,12 @@ module Inttegro
29
30
  # @return [Boolean, nil]
30
31
  #
31
32
  # @!attribute [r] schedule
32
- # Active payout schedule
33
+ # Active payout schedule returned when settings are retrieved.
33
34
  #
34
35
  # Optional in the API payload; omitted values default to `nil`. Wire name: `schedule`.
35
36
  # @return [Inttegro::Payout::SettingsLookupSchedule, nil]
36
37
  class SettingsLookup < T::Struct
37
- const :destinations, T::Hash[String, String]
38
+ const :destinations, Inttegro::Payout::Destinations
38
39
  const :fx_enabled, T.nilable(T::Boolean), default: nil
39
40
  const :schedule, T.nilable(Inttegro::Payout::SettingsLookupSchedule), default: nil
40
41
  end
@@ -8,7 +8,7 @@ require_relative "settings_lookup"
8
8
 
9
9
  module Inttegro
10
10
  class Payout
11
- # Typed representation of the get settings response object in the Inttegro API.
11
+ # Response envelope containing complete payout settings.
12
12
  #
13
13
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
14
14
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -21,7 +21,7 @@ module Inttegro
21
21
  #
22
22
  # Optional in the API payload; omitted values default to `nil`. Wire name: `settings`.
23
23
  # @return [Inttegro::Payout::SettingsLookup, nil]
24
- class GetSettingsResponse < T::Struct
24
+ class SettingsLookupResponse < T::Struct
25
25
  const :settings, T.nilable(Inttegro::Payout::SettingsLookup), default: nil
26
26
  end
27
27
  end
@@ -8,7 +8,7 @@ require_relative "settings_lookup_schedule_aging_spec"
8
8
 
9
9
  module Inttegro
10
10
  class Payout
11
- # Active payout schedule
11
+ # Active payout schedule returned when settings are retrieved.
12
12
  #
13
13
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
14
14
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -17,7 +17,7 @@ module Inttegro
17
17
  # @api public
18
18
  #
19
19
  # @!attribute [r] aging_spec
20
- # Value of the `aging_spec` field in the Inttegro API payload.
20
+ # Rules that determine when balance transactions become eligible for payout.
21
21
  #
22
22
  # Required in the API payload. Wire name: `aging_spec`.
23
23
  # @return [Inttegro::Payout::SettingsLookupScheduleAgingSpec]
@@ -7,7 +7,7 @@ require_relative "base"
7
7
 
8
8
  module Inttegro
9
9
  class Payout
10
- # Typed representation of the settings lookup schedule aging spec object in the Inttegro API.
10
+ # Rules that determine when balance transactions become eligible for payout.
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
@@ -16,19 +16,19 @@ module Inttegro
16
16
  # @api public
17
17
  #
18
18
  # @!attribute [r] abide
19
- # Value of the `abide` field in the Inttegro API payload.
19
+ # How strictly the aging period is applied.
20
20
  #
21
21
  # Required in the API payload. Wire name: `abide`.
22
22
  # @return [String]
23
23
  #
24
24
  # @!attribute [r] label
25
- # Value of the `label` field in the Inttegro API payload.
25
+ # Human-readable aging rule label.
26
26
  #
27
27
  # Required in the API payload. Wire name: `label`.
28
28
  # @return [String]
29
29
  #
30
30
  # @!attribute [r] t_plus
31
- # Value of the `t_plus` field in the Inttegro API payload.
31
+ # Required transaction age.
32
32
  #
33
33
  # Required in the API payload. Wire name: `t_plus`.
34
34
  # @return [String]
@@ -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 "destinations"
7
8
  require_relative "settings_mutation_schedule"
8
9
 
9
10
  module Inttegro
@@ -17,10 +18,16 @@ module Inttegro
17
18
  # @api public
18
19
  #
19
20
  # @!attribute [r] destinations
20
- # Currency-to-financial-account destination assignments.
21
+ # Supported currency-to-financial-account destination assignments.
21
22
  #
22
23
  # Optional in the API payload; omitted values default to `nil`. Wire name: `destinations`.
23
- # @return [Hash{String => String}, nil]
24
+ # @return [Inttegro::Payout::Destinations, nil]
25
+ #
26
+ # @!attribute [r] fx_enabled
27
+ # Updated foreign-exchange setting, returned by FX mutations.
28
+ #
29
+ # Optional in the API payload; omitted values default to `nil`. Wire name: `fx_enabled`.
30
+ # @return [Boolean, nil]
24
31
  #
25
32
  # @!attribute [r] id
26
33
  # Payout settings identifier
@@ -29,12 +36,13 @@ module Inttegro
29
36
  # @return [String, nil]
30
37
  #
31
38
  # @!attribute [r] schedule
32
- # Updated payout schedule
39
+ # Updated payout schedule returned after a settings mutation.
33
40
  #
34
41
  # Optional in the API payload; omitted values default to `nil`. Wire name: `schedule`.
35
42
  # @return [Inttegro::Payout::SettingsMutationSchedule, nil]
36
43
  class SettingsMutation < T::Struct
37
- const :destinations, T.nilable(T::Hash[String, String]), default: nil
44
+ const :destinations, T.nilable(Inttegro::Payout::Destinations), default: nil
45
+ const :fx_enabled, T.nilable(T::Boolean), default: nil
38
46
  const :id, T.nilable(String), default: nil
39
47
  const :schedule, T.nilable(Inttegro::Payout::SettingsMutationSchedule), default: nil
40
48
  end
@@ -8,7 +8,7 @@ require_relative "settings_mutation"
8
8
 
9
9
  module Inttegro
10
10
  class Payout
11
- # Typed representation of the set destinations response object in the Inttegro API.
11
+ # Response envelope containing updated payout settings.
12
12
  #
13
13
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
14
14
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -21,7 +21,7 @@ module Inttegro
21
21
  #
22
22
  # Optional in the API payload; omitted values default to `nil`. Wire name: `settings`.
23
23
  # @return [Inttegro::Payout::SettingsMutation, nil]
24
- class SetDestinationsResponse < T::Struct
24
+ class SettingsMutationResponse < T::Struct
25
25
  const :settings, T.nilable(Inttegro::Payout::SettingsMutation), default: nil
26
26
  end
27
27
  end
@@ -8,7 +8,7 @@ require_relative "settings_mutation_schedule_spec"
8
8
 
9
9
  module Inttegro
10
10
  class Payout
11
- # Updated payout schedule
11
+ # Updated payout schedule returned after a settings mutation.
12
12
  #
13
13
  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
14
14
  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -47,7 +47,7 @@ module Inttegro
47
47
  # @return [String]
48
48
  #
49
49
  # @!attribute [r] spec
50
- # Value of the `spec` field in the Inttegro API payload.
50
+ # Public payout schedule specification returned after a settings mutation.
51
51
  #
52
52
  # Required in the API payload. Wire name: `spec`.
53
53
  # @return [Inttegro::Payout::SettingsMutationScheduleSpec]
@@ -7,7 +7,7 @@ require_relative "base"
7
7
 
8
8
  module Inttegro
9
9
  class Payout
10
- # Typed representation of the settings mutation schedule spec object in the Inttegro API.
10
+ # Public payout schedule specification returned after a settings mutation.
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
@@ -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 "../custom_data"
7
8
  require_relative "../product/dimensions"
8
9
  require_relative "../product/media"
9
10
  require_relative "../product/shipment"
@@ -67,7 +68,7 @@ module Inttegro
67
68
  # collection rather than a raw map.
68
69
  #
69
70
  # Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
70
- # @return [Hash{String => String}, nil]
71
+ # @return [Inttegro::CustomData, nil]
71
72
  #
72
73
  # @!attribute [r] description
73
74
  # Short description
@@ -142,7 +143,7 @@ module Inttegro
142
143
  const :attributes, T.nilable(T::Array[Inttegro::PurchaseIntent::ProductAttributesItem]), default: nil
143
144
  const :category, T.nilable(String), default: nil
144
145
  const :created_at, Time
145
- const :custom_data, T.nilable(T::Hash[String, String]), default: nil
146
+ const :custom_data, T.nilable(Inttegro::CustomData), default: nil
146
147
  const :description, T.nilable(String), default: nil
147
148
  const :dimensions, T.nilable(Inttegro::Product::Dimensions), default: nil
148
149
  const :media, T.nilable(Inttegro::Product::Media), default: nil
@@ -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 "../custom_data"
7
8
  require_relative "attribute"
8
9
  require_relative "dimensions"
9
10
  require_relative "media"
@@ -103,7 +104,7 @@ module Inttegro
103
104
  # collection rather than a raw map.
104
105
  #
105
106
  # Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
106
- # @return [Hash{String => String}, nil]
107
+ # @return [Inttegro::CustomData, nil]
107
108
  class CreateRequest < T::Struct
108
109
  const :type, Inttegro::Product::Type
109
110
  const :reference, T.nilable(String), default: nil
@@ -118,7 +119,7 @@ module Inttegro
118
119
  const :media, T.nilable(Inttegro::Product::Media), default: nil
119
120
  const :attributes, T.nilable(T::Array[Inttegro::Product::Attribute]), default: nil
120
121
  const :publish, T.nilable(T::Boolean), default: nil
121
- const :custom_data, T.nilable(T::Hash[String, String]), default: nil
122
+ const :custom_data, T.nilable(Inttegro::CustomData), default: nil
122
123
  end
123
124
  end
124
125
  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 "../custom_data"
7
8
  require_relative "../price/price_params"
8
9
  require_relative "type"
9
10
 
@@ -28,7 +29,7 @@ module Inttegro
28
29
  # collection rather than a raw map.
29
30
  #
30
31
  # Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
31
- # @return [Hash{String => String}, nil]
32
+ # @return [Inttegro::CustomData, nil]
32
33
  #
33
34
  # @!attribute [r] name
34
35
  # Product name shown to the customer
@@ -67,7 +68,7 @@ module Inttegro
67
68
  # @return [Inttegro::Product::Type]
68
69
  class InlineDetails < T::Struct
69
70
  const :about, T.nilable(String), default: nil
70
- const :custom_data, T.nilable(T::Hash[String, String]), default: nil
71
+ const :custom_data, T.nilable(Inttegro::CustomData), default: nil
71
72
  const :name, String
72
73
  const :price, Inttegro::Price::PriceParams
73
74
  const :quantity, Integer
@@ -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 "../custom_data"
7
8
  require_relative "attribute"
8
9
  require_relative "dimensions"
9
10
  require_relative "media"
@@ -103,7 +104,7 @@ module Inttegro
103
104
  # collection rather than a raw map.
104
105
  #
105
106
  # Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
106
- # @return [Hash{String => String}, nil]
107
+ # @return [Inttegro::CustomData, nil]
107
108
  #
108
109
  # @!attribute [r] active
109
110
  # Whether product is published and available
@@ -154,7 +155,7 @@ module Inttegro
154
155
  const :media, T.nilable(Inttegro::Product::Media), default: nil
155
156
  const :attributes, T.nilable(T::Array[Inttegro::Product::Attribute]), default: nil
156
157
  const :dimensions, T.nilable(Inttegro::Product::Dimensions), default: nil
157
- const :custom_data, T.nilable(T::Hash[String, String]), default: nil
158
+ const :custom_data, T.nilable(Inttegro::CustomData), default: nil
158
159
  const :active, T::Boolean
159
160
  const :created_at, Time
160
161
  const :updated_at, T.nilable(Time), default: nil
@@ -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 "../custom_data"
7
8
  require_relative "attribute"
8
9
  require_relative "dimensions"
9
10
  require_relative "media"
@@ -103,7 +104,7 @@ module Inttegro
103
104
  # collection rather than a raw map.
104
105
  #
105
106
  # Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
106
- # @return [Hash{String => String}, nil]
107
+ # @return [Inttegro::CustomData, nil]
107
108
  class UpdateRequest < T::Struct
108
109
  const :product_id, String
109
110
  const :type, T.nilable(Inttegro::Product::Type), default: nil
@@ -118,7 +119,7 @@ module Inttegro
118
119
  const :media, T.nilable(Inttegro::Product::Media), default: nil
119
120
  const :images, T.nilable(T::Array[String]), default: nil
120
121
  const :attributes, T.nilable(T::Array[Inttegro::Product::Attribute]), default: nil
121
- const :custom_data, T.nilable(T::Hash[String, String]), default: nil
122
+ const :custom_data, T.nilable(Inttegro::CustomData), default: nil
122
123
  end
123
124
  end
124
125
  end