increase 1.237.0 → 1.239.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 +16 -0
- data/README.md +1 -1
- data/lib/increase/client.rb +4 -0
- data/lib/increase/models/beneficial_owner_list_params.rb +54 -0
- data/lib/increase/models/beneficial_owner_retrieve_params.rb +22 -0
- data/lib/increase/models/card_payment.rb +139 -90
- data/lib/increase/models/entity.rb +3 -207
- data/lib/increase/models/entity_beneficial_owner.rb +238 -0
- data/lib/increase/models/real_time_decision.rb +138 -86
- data/lib/increase/models.rb +6 -0
- data/lib/increase/resources/beneficial_owners.rb +67 -0
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +4 -0
- data/rbi/increase/client.rbi +3 -0
- data/rbi/increase/models/beneficial_owner_list_params.rbi +89 -0
- data/rbi/increase/models/beneficial_owner_retrieve_params.rbi +46 -0
- data/rbi/increase/models/card_payment.rbi +316 -165
- data/rbi/increase/models/entity.rbi +3 -403
- data/rbi/increase/models/entity_beneficial_owner.rbi +412 -0
- data/rbi/increase/models/real_time_decision.rbi +316 -165
- data/rbi/increase/models.rbi +7 -0
- data/rbi/increase/resources/beneficial_owners.rbi +54 -0
- data/sig/increase/client.rbs +2 -0
- data/sig/increase/models/beneficial_owner_list_params.rbs +47 -0
- data/sig/increase/models/beneficial_owner_retrieve_params.rbs +24 -0
- data/sig/increase/models/card_payment.rbs +115 -67
- data/sig/increase/models/entity.rbs +4 -174
- data/sig/increase/models/entity_beneficial_owner.rbs +193 -0
- data/sig/increase/models/real_time_decision.rbs +114 -67
- data/sig/increase/models.rbs +6 -0
- data/sig/increase/resources/beneficial_owners.rbs +20 -0
- metadata +14 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 68b25ad092849f14357d0e14badb9dc474f02a8e5c4ec6f7e7e5994d19d3e062
|
|
4
|
+
data.tar.gz: 13a6c13e98500137399c5674e8978ae72c1b558fec0abcbb325dc40db8739c51
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bcdc889c8b54f700658571d76fb216122e474d9d16efe586f3d15273841ec13951105075cc2840d44df325d6d570a3c11ddfdea36863da63717c3b74b6a7a770
|
|
7
|
+
data.tar.gz: 72053d1b2aa394adce52cac31af22e4504eee78b00765d98ff960b58e898841203ba7b5376370fb48222b004bbbaa6bacac138f059f8621770066abee8919650
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.239.0 (2026-03-10)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.238.0...v1.239.0](https://github.com/Increase/increase-ruby/compare/v1.238.0...v1.239.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([1431693](https://github.com/Increase/increase-ruby/commit/14316937bb3c4a431a0beae5bb85a37b6d6910a0))
|
|
10
|
+
|
|
11
|
+
## 1.238.0 (2026-03-09)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v1.237.0...v1.238.0](https://github.com/Increase/increase-ruby/compare/v1.237.0...v1.238.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** api update ([1836a3f](https://github.com/Increase/increase-ruby/commit/1836a3ff6323ab99707b78598cb3762cf558c409))
|
|
18
|
+
|
|
3
19
|
## 1.237.0 (2026-03-09)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v1.236.0...v1.237.0](https://github.com/Increase/increase-ruby/compare/v1.236.0...v1.237.0)
|
data/README.md
CHANGED
data/lib/increase/client.rb
CHANGED
|
@@ -125,6 +125,9 @@ module Increase
|
|
|
125
125
|
# @return [Increase::Resources::Entities]
|
|
126
126
|
attr_reader :entities
|
|
127
127
|
|
|
128
|
+
# @return [Increase::Resources::BeneficialOwners]
|
|
129
|
+
attr_reader :beneficial_owners
|
|
130
|
+
|
|
128
131
|
# @return [Increase::Resources::SupplementalDocuments]
|
|
129
132
|
attr_reader :supplemental_documents
|
|
130
133
|
|
|
@@ -291,6 +294,7 @@ module Increase
|
|
|
291
294
|
@routing_numbers = Increase::Resources::RoutingNumbers.new(client: self)
|
|
292
295
|
@external_accounts = Increase::Resources::ExternalAccounts.new(client: self)
|
|
293
296
|
@entities = Increase::Resources::Entities.new(client: self)
|
|
297
|
+
@beneficial_owners = Increase::Resources::BeneficialOwners.new(client: self)
|
|
294
298
|
@supplemental_documents = Increase::Resources::SupplementalDocuments.new(client: self)
|
|
295
299
|
@programs = Increase::Resources::Programs.new(client: self)
|
|
296
300
|
@account_statements = Increase::Resources::AccountStatements.new(client: self)
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::BeneficialOwners#list
|
|
6
|
+
class BeneficialOwnerListParams < Increase::Internal::Type::BaseModel
|
|
7
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Increase::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute entity_id
|
|
11
|
+
# The identifier of the Entity to list beneficial owners for. Only `corporation`
|
|
12
|
+
# entities have beneficial owners.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :entity_id, String
|
|
16
|
+
|
|
17
|
+
# @!attribute cursor
|
|
18
|
+
# Return the page of entries after this one.
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :cursor, String
|
|
22
|
+
|
|
23
|
+
# @!attribute idempotency_key
|
|
24
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
25
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
26
|
+
# request is only processed once. Learn more about
|
|
27
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
28
|
+
#
|
|
29
|
+
# @return [String, nil]
|
|
30
|
+
optional :idempotency_key, String
|
|
31
|
+
|
|
32
|
+
# @!attribute limit
|
|
33
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
34
|
+
# objects.
|
|
35
|
+
#
|
|
36
|
+
# @return [Integer, nil]
|
|
37
|
+
optional :limit, Integer
|
|
38
|
+
|
|
39
|
+
# @!method initialize(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
40
|
+
# Some parameter documentations has been truncated, see
|
|
41
|
+
# {Increase::Models::BeneficialOwnerListParams} for more details.
|
|
42
|
+
#
|
|
43
|
+
# @param entity_id [String] The identifier of the Entity to list beneficial owners for. Only `corporation` e
|
|
44
|
+
#
|
|
45
|
+
# @param cursor [String] Return the page of entries after this one.
|
|
46
|
+
#
|
|
47
|
+
# @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
|
|
48
|
+
#
|
|
49
|
+
# @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
|
|
50
|
+
#
|
|
51
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::BeneficialOwners#retrieve
|
|
6
|
+
class BeneficialOwnerRetrieveParams < Increase::Internal::Type::BaseModel
|
|
7
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Increase::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute entity_beneficial_owner_id
|
|
11
|
+
# The identifier of the Beneficial Owner to retrieve.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :entity_beneficial_owner_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(entity_beneficial_owner_id:, request_options: {})
|
|
17
|
+
# @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to retrieve.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -398,16 +398,6 @@ module Increase
|
|
|
398
398
|
# @return [String, nil]
|
|
399
399
|
required :cardholder_name, String, nil?: true
|
|
400
400
|
|
|
401
|
-
# @!attribute category
|
|
402
|
-
# The category of the card authentication attempt.
|
|
403
|
-
#
|
|
404
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Category, nil]
|
|
405
|
-
required :category,
|
|
406
|
-
enum: -> {
|
|
407
|
-
Increase::CardPayment::Element::CardAuthentication::Category
|
|
408
|
-
},
|
|
409
|
-
nil?: true
|
|
410
|
-
|
|
411
401
|
# @!attribute challenge
|
|
412
402
|
# Details about the challenge, if one was requested.
|
|
413
403
|
#
|
|
@@ -472,6 +462,12 @@ module Increase
|
|
|
472
462
|
# @return [String, nil]
|
|
473
463
|
required :merchant_name, String, nil?: true
|
|
474
464
|
|
|
465
|
+
# @!attribute message_category
|
|
466
|
+
# The message category of the card authentication attempt.
|
|
467
|
+
#
|
|
468
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory]
|
|
469
|
+
required :message_category, -> { Increase::CardPayment::Element::CardAuthentication::MessageCategory }
|
|
470
|
+
|
|
475
471
|
# @!attribute prior_authenticated_card_payment_id
|
|
476
472
|
# The ID of a prior Card Authentication that the requestor used to authenticate
|
|
477
473
|
# this cardholder for a previous transaction.
|
|
@@ -479,26 +475,6 @@ module Increase
|
|
|
479
475
|
# @return [String, nil]
|
|
480
476
|
required :prior_authenticated_card_payment_id, String, nil?: true
|
|
481
477
|
|
|
482
|
-
# @!attribute purchase_amount
|
|
483
|
-
# The purchase amount in minor units.
|
|
484
|
-
#
|
|
485
|
-
# @return [Integer, nil]
|
|
486
|
-
required :purchase_amount, Integer, nil?: true
|
|
487
|
-
|
|
488
|
-
# @!attribute purchase_amount_cardholder_estimated
|
|
489
|
-
# The purchase amount in the cardholder's currency (i.e., USD) estimated using
|
|
490
|
-
# daily conversion rates from the card network.
|
|
491
|
-
#
|
|
492
|
-
# @return [Integer, nil]
|
|
493
|
-
required :purchase_amount_cardholder_estimated, Integer, nil?: true
|
|
494
|
-
|
|
495
|
-
# @!attribute purchase_currency
|
|
496
|
-
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
497
|
-
# authentication attempt's purchase currency.
|
|
498
|
-
#
|
|
499
|
-
# @return [String, nil]
|
|
500
|
-
required :purchase_currency, String, nil?: true
|
|
501
|
-
|
|
502
478
|
# @!attribute real_time_decision_id
|
|
503
479
|
# The identifier of the Real-Time Decision sent to approve or decline this
|
|
504
480
|
# authentication attempt.
|
|
@@ -594,14 +570,6 @@ module Increase
|
|
|
594
570
|
# @return [String]
|
|
595
571
|
required :three_d_secure_server_transaction_id, String
|
|
596
572
|
|
|
597
|
-
# @!attribute transaction_type
|
|
598
|
-
# The type of transaction being authenticated.
|
|
599
|
-
#
|
|
600
|
-
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::TransactionType, nil]
|
|
601
|
-
required :transaction_type,
|
|
602
|
-
enum: -> { Increase::CardPayment::Element::CardAuthentication::TransactionType },
|
|
603
|
-
nil?: true
|
|
604
|
-
|
|
605
573
|
# @!attribute type
|
|
606
574
|
# A constant representing the object's type. For this resource it will always be
|
|
607
575
|
# `card_authentication`.
|
|
@@ -609,7 +577,7 @@ module Increase
|
|
|
609
577
|
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type]
|
|
610
578
|
required :type, enum: -> { Increase::CardPayment::Element::CardAuthentication::Type }
|
|
611
579
|
|
|
612
|
-
# @!method initialize(id:, access_control_server_transaction_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, card_payment_id:, cardholder_email:, cardholder_name:,
|
|
580
|
+
# @!method initialize(id:, access_control_server_transaction_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, card_payment_id:, cardholder_email:, cardholder_name:, challenge:, created_at:, deny_reason:, device_channel:, directory_server_transaction_id:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, message_category:, prior_authenticated_card_payment_id:, real_time_decision_id:, requestor_authentication_indicator:, requestor_challenge_indicator:, requestor_name:, requestor_url:, shipping_address_city:, shipping_address_country:, shipping_address_line1:, shipping_address_line2:, shipping_address_line3:, shipping_address_postal_code:, shipping_address_state:, status:, three_d_secure_server_transaction_id:, type:)
|
|
613
581
|
# Some parameter documentations has been truncated, see
|
|
614
582
|
# {Increase::Models::CardPayment::Element::CardAuthentication} for more details.
|
|
615
583
|
#
|
|
@@ -643,8 +611,6 @@ module Increase
|
|
|
643
611
|
#
|
|
644
612
|
# @param cardholder_name [String, nil] The name of the cardholder.
|
|
645
613
|
#
|
|
646
|
-
# @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Category, nil] The category of the card authentication attempt.
|
|
647
|
-
#
|
|
648
614
|
# @param challenge [Increase::Models::CardPayment::Element::CardAuthentication::Challenge, nil] Details about the challenge, if one was requested.
|
|
649
615
|
#
|
|
650
616
|
# @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Au
|
|
@@ -663,13 +629,9 @@ module Increase
|
|
|
663
629
|
#
|
|
664
630
|
# @param merchant_name [String, nil] The name of the merchant.
|
|
665
631
|
#
|
|
666
|
-
# @param
|
|
667
|
-
#
|
|
668
|
-
# @param purchase_amount [Integer, nil] The purchase amount in minor units.
|
|
632
|
+
# @param message_category [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory] The message category of the card authentication attempt.
|
|
669
633
|
#
|
|
670
|
-
# @param
|
|
671
|
-
#
|
|
672
|
-
# @param purchase_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
|
|
634
|
+
# @param prior_authenticated_card_payment_id [String, nil] The ID of a prior Card Authentication that the requestor used to authenticate th
|
|
673
635
|
#
|
|
674
636
|
# @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this authent
|
|
675
637
|
#
|
|
@@ -699,26 +661,8 @@ module Increase
|
|
|
699
661
|
#
|
|
700
662
|
# @param three_d_secure_server_transaction_id [String] A unique identifier assigned by the 3DS Server initiating the authentication att
|
|
701
663
|
#
|
|
702
|
-
# @param transaction_type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::TransactionType, nil] The type of transaction being authenticated.
|
|
703
|
-
#
|
|
704
664
|
# @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type] A constant representing the object's type. For this resource it will always be `
|
|
705
665
|
|
|
706
|
-
# The category of the card authentication attempt.
|
|
707
|
-
#
|
|
708
|
-
# @see Increase::Models::CardPayment::Element::CardAuthentication#category
|
|
709
|
-
module Category
|
|
710
|
-
extend Increase::Internal::Type::Enum
|
|
711
|
-
|
|
712
|
-
# The authentication attempt is for a payment.
|
|
713
|
-
PAYMENT_AUTHENTICATION = :payment_authentication
|
|
714
|
-
|
|
715
|
-
# The authentication attempt is not for a payment.
|
|
716
|
-
NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
|
|
717
|
-
|
|
718
|
-
# @!method self.values
|
|
719
|
-
# @return [Array<Symbol>]
|
|
720
|
-
end
|
|
721
|
-
|
|
722
666
|
# @see Increase::Models::CardPayment::Element::CardAuthentication#challenge
|
|
723
667
|
class Challenge < Increase::Internal::Type::BaseModel
|
|
724
668
|
# @!attribute attempts
|
|
@@ -1065,6 +1009,136 @@ module Increase
|
|
|
1065
1009
|
end
|
|
1066
1010
|
end
|
|
1067
1011
|
|
|
1012
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication#message_category
|
|
1013
|
+
class MessageCategory < Increase::Internal::Type::BaseModel
|
|
1014
|
+
# @!attribute category
|
|
1015
|
+
# The category of the card authentication attempt.
|
|
1016
|
+
#
|
|
1017
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Category]
|
|
1018
|
+
required :category,
|
|
1019
|
+
enum: -> { Increase::CardPayment::Element::CardAuthentication::MessageCategory::Category }
|
|
1020
|
+
|
|
1021
|
+
# @!attribute non_payment
|
|
1022
|
+
# Fields specific to non-payment authentication attempts.
|
|
1023
|
+
#
|
|
1024
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::NonPayment, nil]
|
|
1025
|
+
required :non_payment,
|
|
1026
|
+
-> { Increase::CardPayment::Element::CardAuthentication::MessageCategory::NonPayment },
|
|
1027
|
+
nil?: true
|
|
1028
|
+
|
|
1029
|
+
# @!attribute payment
|
|
1030
|
+
# Fields specific to payment authentication attempts.
|
|
1031
|
+
#
|
|
1032
|
+
# @return [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment, nil]
|
|
1033
|
+
required :payment,
|
|
1034
|
+
-> { Increase::CardPayment::Element::CardAuthentication::MessageCategory::Payment },
|
|
1035
|
+
nil?: true
|
|
1036
|
+
|
|
1037
|
+
# @!method initialize(category:, non_payment:, payment:)
|
|
1038
|
+
# The message category of the card authentication attempt.
|
|
1039
|
+
#
|
|
1040
|
+
# @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Category] The category of the card authentication attempt.
|
|
1041
|
+
#
|
|
1042
|
+
# @param non_payment [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::NonPayment, nil] Fields specific to non-payment authentication attempts.
|
|
1043
|
+
#
|
|
1044
|
+
# @param payment [Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment, nil] Fields specific to payment authentication attempts.
|
|
1045
|
+
|
|
1046
|
+
# The category of the card authentication attempt.
|
|
1047
|
+
#
|
|
1048
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory#category
|
|
1049
|
+
module Category
|
|
1050
|
+
extend Increase::Internal::Type::Enum
|
|
1051
|
+
|
|
1052
|
+
# The authentication attempt is for a payment.
|
|
1053
|
+
PAYMENT_AUTHENTICATION = :payment_authentication
|
|
1054
|
+
|
|
1055
|
+
# The authentication attempt is not for a payment.
|
|
1056
|
+
NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
|
|
1057
|
+
|
|
1058
|
+
# @!method self.values
|
|
1059
|
+
# @return [Array<Symbol>]
|
|
1060
|
+
end
|
|
1061
|
+
|
|
1062
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory#non_payment
|
|
1063
|
+
class NonPayment < Increase::Internal::Type::BaseModel
|
|
1064
|
+
# @!method initialize
|
|
1065
|
+
# Fields specific to non-payment authentication attempts.
|
|
1066
|
+
end
|
|
1067
|
+
|
|
1068
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory#payment
|
|
1069
|
+
class Payment < Increase::Internal::Type::BaseModel
|
|
1070
|
+
# @!attribute purchase_amount
|
|
1071
|
+
# The purchase amount in minor units.
|
|
1072
|
+
#
|
|
1073
|
+
# @return [Integer]
|
|
1074
|
+
required :purchase_amount, Integer
|
|
1075
|
+
|
|
1076
|
+
# @!attribute purchase_amount_cardholder_estimated
|
|
1077
|
+
# The purchase amount in the cardholder's currency (i.e., USD) estimated using
|
|
1078
|
+
# daily conversion rates from the card network.
|
|
1079
|
+
#
|
|
1080
|
+
# @return [Integer, nil]
|
|
1081
|
+
required :purchase_amount_cardholder_estimated, Integer, nil?: true
|
|
1082
|
+
|
|
1083
|
+
# @!attribute purchase_currency
|
|
1084
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1085
|
+
# authentication attempt's purchase currency.
|
|
1086
|
+
#
|
|
1087
|
+
# @return [String]
|
|
1088
|
+
required :purchase_currency, String
|
|
1089
|
+
|
|
1090
|
+
# @!attribute transaction_type
|
|
1091
|
+
# The type of transaction being authenticated.
|
|
1092
|
+
#
|
|
1093
|
+
# @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment::TransactionType, nil]
|
|
1094
|
+
required :transaction_type,
|
|
1095
|
+
enum: -> {
|
|
1096
|
+
Increase::CardPayment::Element::CardAuthentication::MessageCategory::Payment::TransactionType
|
|
1097
|
+
},
|
|
1098
|
+
nil?: true
|
|
1099
|
+
|
|
1100
|
+
# @!method initialize(purchase_amount:, purchase_amount_cardholder_estimated:, purchase_currency:, transaction_type:)
|
|
1101
|
+
# Some parameter documentations has been truncated, see
|
|
1102
|
+
# {Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment}
|
|
1103
|
+
# for more details.
|
|
1104
|
+
#
|
|
1105
|
+
# Fields specific to payment authentication attempts.
|
|
1106
|
+
#
|
|
1107
|
+
# @param purchase_amount [Integer] The purchase amount in minor units.
|
|
1108
|
+
#
|
|
1109
|
+
# @param purchase_amount_cardholder_estimated [Integer, nil] The purchase amount in the cardholder's currency (i.e., USD) estimated using dai
|
|
1110
|
+
#
|
|
1111
|
+
# @param purchase_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
|
|
1112
|
+
#
|
|
1113
|
+
# @param transaction_type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment::TransactionType, nil] The type of transaction being authenticated.
|
|
1114
|
+
|
|
1115
|
+
# The type of transaction being authenticated.
|
|
1116
|
+
#
|
|
1117
|
+
# @see Increase::Models::CardPayment::Element::CardAuthentication::MessageCategory::Payment#transaction_type
|
|
1118
|
+
module TransactionType
|
|
1119
|
+
extend Increase::Internal::Type::Enum
|
|
1120
|
+
|
|
1121
|
+
# Purchase of goods or services.
|
|
1122
|
+
GOODS_SERVICE_PURCHASE = :goods_service_purchase
|
|
1123
|
+
|
|
1124
|
+
# Check acceptance.
|
|
1125
|
+
CHECK_ACCEPTANCE = :check_acceptance
|
|
1126
|
+
|
|
1127
|
+
# Account funding.
|
|
1128
|
+
ACCOUNT_FUNDING = :account_funding
|
|
1129
|
+
|
|
1130
|
+
# Quasi-cash transaction.
|
|
1131
|
+
QUASI_CASH_TRANSACTION = :quasi_cash_transaction
|
|
1132
|
+
|
|
1133
|
+
# Prepaid activation and load.
|
|
1134
|
+
PREPAID_ACTIVATION_AND_LOAD = :prepaid_activation_and_load
|
|
1135
|
+
|
|
1136
|
+
# @!method self.values
|
|
1137
|
+
# @return [Array<Symbol>]
|
|
1138
|
+
end
|
|
1139
|
+
end
|
|
1140
|
+
end
|
|
1141
|
+
|
|
1068
1142
|
# The 3DS requestor authentication indicator describes why the authentication
|
|
1069
1143
|
# attempt is performed, such as for a recurring transaction.
|
|
1070
1144
|
#
|
|
@@ -1175,31 +1249,6 @@ module Increase
|
|
|
1175
1249
|
# @return [Array<Symbol>]
|
|
1176
1250
|
end
|
|
1177
1251
|
|
|
1178
|
-
# The type of transaction being authenticated.
|
|
1179
|
-
#
|
|
1180
|
-
# @see Increase::Models::CardPayment::Element::CardAuthentication#transaction_type
|
|
1181
|
-
module TransactionType
|
|
1182
|
-
extend Increase::Internal::Type::Enum
|
|
1183
|
-
|
|
1184
|
-
# Purchase of goods or services.
|
|
1185
|
-
GOODS_SERVICE_PURCHASE = :goods_service_purchase
|
|
1186
|
-
|
|
1187
|
-
# Check acceptance.
|
|
1188
|
-
CHECK_ACCEPTANCE = :check_acceptance
|
|
1189
|
-
|
|
1190
|
-
# Account funding.
|
|
1191
|
-
ACCOUNT_FUNDING = :account_funding
|
|
1192
|
-
|
|
1193
|
-
# Quasi-cash transaction.
|
|
1194
|
-
QUASI_CASH_TRANSACTION = :quasi_cash_transaction
|
|
1195
|
-
|
|
1196
|
-
# Prepaid activation and load.
|
|
1197
|
-
PREPAID_ACTIVATION_AND_LOAD = :prepaid_activation_and_load
|
|
1198
|
-
|
|
1199
|
-
# @!method self.values
|
|
1200
|
-
# @return [Array<Symbol>]
|
|
1201
|
-
end
|
|
1202
|
-
|
|
1203
1252
|
# A constant representing the object's type. For this resource it will always be
|
|
1204
1253
|
# `card_authentication`.
|
|
1205
1254
|
#
|
|
@@ -174,9 +174,8 @@ module Increase
|
|
|
174
174
|
# The identifying details of anyone controlling or owning 25% or more of the
|
|
175
175
|
# corporation.
|
|
176
176
|
#
|
|
177
|
-
# @return [Array<Increase::Models::
|
|
178
|
-
required :beneficial_owners,
|
|
179
|
-
-> { Increase::Internal::Type::ArrayOf[Increase::Entity::Corporation::BeneficialOwner] }
|
|
177
|
+
# @return [Array<Increase::Models::EntityBeneficialOwner>]
|
|
178
|
+
required :beneficial_owners, -> { Increase::Internal::Type::ArrayOf[Increase::EntityBeneficialOwner] }
|
|
180
179
|
|
|
181
180
|
# @!attribute email
|
|
182
181
|
# An email address for the business.
|
|
@@ -225,7 +224,7 @@ module Increase
|
|
|
225
224
|
#
|
|
226
225
|
# @param address [Increase::Models::Entity::Corporation::Address] The corporation's address.
|
|
227
226
|
#
|
|
228
|
-
# @param beneficial_owners [Array<Increase::Models::
|
|
227
|
+
# @param beneficial_owners [Array<Increase::Models::EntityBeneficialOwner>] The identifying details of anyone controlling or owning 25% or more of the corpo
|
|
229
228
|
#
|
|
230
229
|
# @param email [String, nil] An email address for the business.
|
|
231
230
|
#
|
|
@@ -288,209 +287,6 @@ module Increase
|
|
|
288
287
|
#
|
|
289
288
|
# @param zip [String] The ZIP code of the address.
|
|
290
289
|
end
|
|
291
|
-
|
|
292
|
-
class BeneficialOwner < Increase::Internal::Type::BaseModel
|
|
293
|
-
# @!attribute id
|
|
294
|
-
# The identifier of this beneficial owner.
|
|
295
|
-
#
|
|
296
|
-
# @return [String]
|
|
297
|
-
required :id, String
|
|
298
|
-
|
|
299
|
-
# @!attribute company_title
|
|
300
|
-
# This person's role or title within the entity.
|
|
301
|
-
#
|
|
302
|
-
# @return [String, nil]
|
|
303
|
-
required :company_title, String, nil?: true
|
|
304
|
-
|
|
305
|
-
# @!attribute individual
|
|
306
|
-
# Personal details for the beneficial owner.
|
|
307
|
-
#
|
|
308
|
-
# @return [Increase::Models::Entity::Corporation::BeneficialOwner::Individual]
|
|
309
|
-
required :individual, -> { Increase::Entity::Corporation::BeneficialOwner::Individual }
|
|
310
|
-
|
|
311
|
-
# @!attribute prongs
|
|
312
|
-
# Why this person is considered a beneficial owner of the entity.
|
|
313
|
-
#
|
|
314
|
-
# @return [Array<Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong>]
|
|
315
|
-
required :prongs,
|
|
316
|
-
-> { Increase::Internal::Type::ArrayOf[enum: Increase::Entity::Corporation::BeneficialOwner::Prong] }
|
|
317
|
-
|
|
318
|
-
# @!method initialize(id:, company_title:, individual:, prongs:)
|
|
319
|
-
# @param id [String] The identifier of this beneficial owner.
|
|
320
|
-
#
|
|
321
|
-
# @param company_title [String, nil] This person's role or title within the entity.
|
|
322
|
-
#
|
|
323
|
-
# @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual] Personal details for the beneficial owner.
|
|
324
|
-
#
|
|
325
|
-
# @param prongs [Array<Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong>] Why this person is considered a beneficial owner of the entity.
|
|
326
|
-
|
|
327
|
-
# @see Increase::Models::Entity::Corporation::BeneficialOwner#individual
|
|
328
|
-
class Individual < Increase::Internal::Type::BaseModel
|
|
329
|
-
# @!attribute address
|
|
330
|
-
# The person's address.
|
|
331
|
-
#
|
|
332
|
-
# @return [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address]
|
|
333
|
-
required :address, -> { Increase::Entity::Corporation::BeneficialOwner::Individual::Address }
|
|
334
|
-
|
|
335
|
-
# @!attribute date_of_birth
|
|
336
|
-
# The person's date of birth in YYYY-MM-DD format.
|
|
337
|
-
#
|
|
338
|
-
# @return [Date]
|
|
339
|
-
required :date_of_birth, Date
|
|
340
|
-
|
|
341
|
-
# @!attribute identification
|
|
342
|
-
# A means of verifying the person's identity.
|
|
343
|
-
#
|
|
344
|
-
# @return [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification]
|
|
345
|
-
required :identification,
|
|
346
|
-
-> { Increase::Entity::Corporation::BeneficialOwner::Individual::Identification }
|
|
347
|
-
|
|
348
|
-
# @!attribute name
|
|
349
|
-
# The person's legal name.
|
|
350
|
-
#
|
|
351
|
-
# @return [String]
|
|
352
|
-
required :name, String
|
|
353
|
-
|
|
354
|
-
# @!method initialize(address:, date_of_birth:, identification:, name:)
|
|
355
|
-
# Personal details for the beneficial owner.
|
|
356
|
-
#
|
|
357
|
-
# @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address] The person's address.
|
|
358
|
-
#
|
|
359
|
-
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
360
|
-
#
|
|
361
|
-
# @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification] A means of verifying the person's identity.
|
|
362
|
-
#
|
|
363
|
-
# @param name [String] The person's legal name.
|
|
364
|
-
|
|
365
|
-
# @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#address
|
|
366
|
-
class Address < Increase::Internal::Type::BaseModel
|
|
367
|
-
# @!attribute city
|
|
368
|
-
# The city, district, town, or village of the address.
|
|
369
|
-
#
|
|
370
|
-
# @return [String, nil]
|
|
371
|
-
required :city, String, nil?: true
|
|
372
|
-
|
|
373
|
-
# @!attribute country
|
|
374
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
375
|
-
#
|
|
376
|
-
# @return [String]
|
|
377
|
-
required :country, String
|
|
378
|
-
|
|
379
|
-
# @!attribute line1
|
|
380
|
-
# The first line of the address.
|
|
381
|
-
#
|
|
382
|
-
# @return [String]
|
|
383
|
-
required :line1, String
|
|
384
|
-
|
|
385
|
-
# @!attribute line2
|
|
386
|
-
# The second line of the address.
|
|
387
|
-
#
|
|
388
|
-
# @return [String, nil]
|
|
389
|
-
required :line2, String, nil?: true
|
|
390
|
-
|
|
391
|
-
# @!attribute state
|
|
392
|
-
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
393
|
-
# state, province, or region of the address.
|
|
394
|
-
#
|
|
395
|
-
# @return [String, nil]
|
|
396
|
-
required :state, String, nil?: true
|
|
397
|
-
|
|
398
|
-
# @!attribute zip
|
|
399
|
-
# The ZIP or postal code of the address.
|
|
400
|
-
#
|
|
401
|
-
# @return [String, nil]
|
|
402
|
-
required :zip, String, nil?: true
|
|
403
|
-
|
|
404
|
-
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
|
405
|
-
# Some parameter documentations has been truncated, see
|
|
406
|
-
# {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address}
|
|
407
|
-
# for more details.
|
|
408
|
-
#
|
|
409
|
-
# The person's address.
|
|
410
|
-
#
|
|
411
|
-
# @param city [String, nil] The city, district, town, or village of the address.
|
|
412
|
-
#
|
|
413
|
-
# @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
414
|
-
#
|
|
415
|
-
# @param line1 [String] The first line of the address.
|
|
416
|
-
#
|
|
417
|
-
# @param line2 [String, nil] The second line of the address.
|
|
418
|
-
#
|
|
419
|
-
# @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
|
|
420
|
-
#
|
|
421
|
-
# @param zip [String, nil] The ZIP or postal code of the address.
|
|
422
|
-
end
|
|
423
|
-
|
|
424
|
-
# @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#identification
|
|
425
|
-
class Identification < Increase::Internal::Type::BaseModel
|
|
426
|
-
# @!attribute method_
|
|
427
|
-
# A method that can be used to verify the individual's identity.
|
|
428
|
-
#
|
|
429
|
-
# @return [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method]
|
|
430
|
-
required :method_,
|
|
431
|
-
enum: -> {
|
|
432
|
-
Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method
|
|
433
|
-
},
|
|
434
|
-
api_name: :method
|
|
435
|
-
|
|
436
|
-
# @!attribute number_last4
|
|
437
|
-
# The last 4 digits of the identification number that can be used to verify the
|
|
438
|
-
# individual's identity.
|
|
439
|
-
#
|
|
440
|
-
# @return [String]
|
|
441
|
-
required :number_last4, String
|
|
442
|
-
|
|
443
|
-
# @!method initialize(method_:, number_last4:)
|
|
444
|
-
# Some parameter documentations has been truncated, see
|
|
445
|
-
# {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification}
|
|
446
|
-
# for more details.
|
|
447
|
-
#
|
|
448
|
-
# A means of verifying the person's identity.
|
|
449
|
-
#
|
|
450
|
-
# @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity.
|
|
451
|
-
#
|
|
452
|
-
# @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
|
|
453
|
-
|
|
454
|
-
# A method that can be used to verify the individual's identity.
|
|
455
|
-
#
|
|
456
|
-
# @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification#method_
|
|
457
|
-
module Method
|
|
458
|
-
extend Increase::Internal::Type::Enum
|
|
459
|
-
|
|
460
|
-
# A social security number.
|
|
461
|
-
SOCIAL_SECURITY_NUMBER = :social_security_number
|
|
462
|
-
|
|
463
|
-
# An individual taxpayer identification number (ITIN).
|
|
464
|
-
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
|
|
465
|
-
|
|
466
|
-
# A passport number.
|
|
467
|
-
PASSPORT = :passport
|
|
468
|
-
|
|
469
|
-
# A driver's license number.
|
|
470
|
-
DRIVERS_LICENSE = :drivers_license
|
|
471
|
-
|
|
472
|
-
# Another identifying document.
|
|
473
|
-
OTHER = :other
|
|
474
|
-
|
|
475
|
-
# @!method self.values
|
|
476
|
-
# @return [Array<Symbol>]
|
|
477
|
-
end
|
|
478
|
-
end
|
|
479
|
-
end
|
|
480
|
-
|
|
481
|
-
module Prong
|
|
482
|
-
extend Increase::Internal::Type::Enum
|
|
483
|
-
|
|
484
|
-
# A person with 25% or greater direct or indirect ownership of the entity.
|
|
485
|
-
OWNERSHIP = :ownership
|
|
486
|
-
|
|
487
|
-
# A person who manages, directs, or has significant control of the entity.
|
|
488
|
-
CONTROL = :control
|
|
489
|
-
|
|
490
|
-
# @!method self.values
|
|
491
|
-
# @return [Array<Symbol>]
|
|
492
|
-
end
|
|
493
|
-
end
|
|
494
290
|
end
|
|
495
291
|
|
|
496
292
|
# @see Increase::Models::Entity#government_authority
|