aws-sdk-taxsettings 1.13.0 → 1.15.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-taxsettings/client.rb +225 -7
- data/lib/aws-sdk-taxsettings/client_api.rb +201 -2
- data/lib/aws-sdk-taxsettings/errors.rb +48 -0
- data/lib/aws-sdk-taxsettings/types.rb +359 -1
- data/lib/aws-sdk-taxsettings.rb +1 -1
- data/sig/client.rbs +81 -3
- data/sig/errors.rbs +9 -0
- data/sig/types.rbs +120 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '09ed96e8d8559330b54d1865bc17ba55eb24ce72214c97bb7aa56b8eb7b58187'
|
4
|
+
data.tar.gz: a32a3de3b916034ff30b195dfa07f6d0fcd344db2b4aa1e5beaf35b4357e37f8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f687854dc7892f1734c7a7a7ae26a7666ec413d684981698349eafe86497ca83a79484bb3969a7a0a2d06047158141a919a0e3e8dcd12445d3b29a6e1c6a8e01
|
7
|
+
data.tar.gz: '08a0c68449e2b41cf7dfab467d8b59591f751f8c8a2787663ca42323ef17ba32831ffd12632089c871072e4ee1a872629f1eef1a41ae636ea489d7623717fac4'
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.15.0 (2024-11-19)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Release Tax Inheritance APIs, Tax Exemption APIs, and functionality update for some existing Tax Registration APIs
|
8
|
+
|
9
|
+
1.14.0 (2024-11-18)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.13.0 (2024-11-01)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.15.0
|
@@ -489,6 +489,52 @@ module Aws::TaxSettings
|
|
489
489
|
req.send_request(options)
|
490
490
|
end
|
491
491
|
|
492
|
+
# Get the active tax exemptions for a given list of accounts.
|
493
|
+
#
|
494
|
+
# @option params [required, Array<String>] :account_ids
|
495
|
+
# List of unique account identifiers.
|
496
|
+
#
|
497
|
+
# @return [Types::BatchGetTaxExemptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
498
|
+
#
|
499
|
+
# * {Types::BatchGetTaxExemptionsResponse#failed_accounts #failed_accounts} => Array<String>
|
500
|
+
# * {Types::BatchGetTaxExemptionsResponse#tax_exemption_details_map #tax_exemption_details_map} => Hash<String,Types::TaxExemptionDetails>
|
501
|
+
#
|
502
|
+
# @example Request syntax with placeholder values
|
503
|
+
#
|
504
|
+
# resp = client.batch_get_tax_exemptions({
|
505
|
+
# account_ids: ["AccountId"], # required
|
506
|
+
# })
|
507
|
+
#
|
508
|
+
# @example Response structure
|
509
|
+
#
|
510
|
+
# resp.failed_accounts #=> Array
|
511
|
+
# resp.failed_accounts[0] #=> String
|
512
|
+
# resp.tax_exemption_details_map #=> Hash
|
513
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_details #=> Boolean
|
514
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_parent_entity #=> String
|
515
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_reason #=> String
|
516
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions #=> Array
|
517
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].authority.country #=> String
|
518
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].authority.state #=> String
|
519
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].effective_date #=> Time
|
520
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].expiration_date #=> Time
|
521
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].status #=> String, one of "None", "Valid", "Expired", "Pending"
|
522
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].system_effective_date #=> Time
|
523
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions #=> Array
|
524
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions[0].country #=> String
|
525
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions[0].state #=> String
|
526
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.description #=> String
|
527
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.display_name #=> String
|
528
|
+
#
|
529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/BatchGetTaxExemptions AWS API Documentation
|
530
|
+
#
|
531
|
+
# @overload batch_get_tax_exemptions(params = {})
|
532
|
+
# @param [Hash] params ({})
|
533
|
+
def batch_get_tax_exemptions(params = {}, options = {})
|
534
|
+
req = build_request(:batch_get_tax_exemptions, params)
|
535
|
+
req.send_request(options)
|
536
|
+
end
|
537
|
+
|
492
538
|
# Adds or updates tax registration for multiple accounts in batch. This
|
493
539
|
# can be used to add or update tax registrations for up to five accounts
|
494
540
|
# in one batch. You can't set a TRN if there's a pending TRN. You'll
|
@@ -630,7 +676,6 @@ module Aws::TaxSettings
|
|
630
676
|
#
|
631
677
|
# * **Note:** In the **Tax Settings** page of the Billing console,
|
632
678
|
# `Government` appears as **Public institutions**
|
633
|
-
#
|
634
679
|
# * If your `sector` is `Business` and you're subject to KDV tax, you
|
635
680
|
# must specify your industry in the `industries` field.
|
636
681
|
#
|
@@ -741,7 +786,11 @@ module Aws::TaxSettings
|
|
741
786
|
# date_of_birth: "DateOfBirth",
|
742
787
|
# tax_registration_documents: [
|
743
788
|
# {
|
744
|
-
#
|
789
|
+
# file: {
|
790
|
+
# file_content: "data", # required
|
791
|
+
# file_name: "TaxDocumentName", # required
|
792
|
+
# },
|
793
|
+
# s3_location: {
|
745
794
|
# bucket: "S3BucketName", # required
|
746
795
|
# key: "S3Key", # required
|
747
796
|
# },
|
@@ -825,6 +874,49 @@ module Aws::TaxSettings
|
|
825
874
|
req.send_request(options)
|
826
875
|
end
|
827
876
|
|
877
|
+
# Get supported tax exemption types.
|
878
|
+
#
|
879
|
+
# @return [Types::GetTaxExemptionTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
880
|
+
#
|
881
|
+
# * {Types::GetTaxExemptionTypesResponse#tax_exemption_types #tax_exemption_types} => Array<Types::TaxExemptionType>
|
882
|
+
#
|
883
|
+
# @example Response structure
|
884
|
+
#
|
885
|
+
# resp.tax_exemption_types #=> Array
|
886
|
+
# resp.tax_exemption_types[0].applicable_jurisdictions #=> Array
|
887
|
+
# resp.tax_exemption_types[0].applicable_jurisdictions[0].country #=> String
|
888
|
+
# resp.tax_exemption_types[0].applicable_jurisdictions[0].state #=> String
|
889
|
+
# resp.tax_exemption_types[0].description #=> String
|
890
|
+
# resp.tax_exemption_types[0].display_name #=> String
|
891
|
+
#
|
892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/GetTaxExemptionTypes AWS API Documentation
|
893
|
+
#
|
894
|
+
# @overload get_tax_exemption_types(params = {})
|
895
|
+
# @param [Hash] params ({})
|
896
|
+
def get_tax_exemption_types(params = {}, options = {})
|
897
|
+
req = build_request(:get_tax_exemption_types, params)
|
898
|
+
req.send_request(options)
|
899
|
+
end
|
900
|
+
|
901
|
+
# The get account tax inheritance status.
|
902
|
+
#
|
903
|
+
# @return [Types::GetTaxInheritanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
904
|
+
#
|
905
|
+
# * {Types::GetTaxInheritanceResponse#heritage_status #heritage_status} => String
|
906
|
+
#
|
907
|
+
# @example Response structure
|
908
|
+
#
|
909
|
+
# resp.heritage_status #=> String, one of "OptIn", "OptOut"
|
910
|
+
#
|
911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/GetTaxInheritance AWS API Documentation
|
912
|
+
#
|
913
|
+
# @overload get_tax_inheritance(params = {})
|
914
|
+
# @param [Hash] params ({})
|
915
|
+
def get_tax_inheritance(params = {}, options = {})
|
916
|
+
req = build_request(:get_tax_inheritance, params)
|
917
|
+
req.send_request(options)
|
918
|
+
end
|
919
|
+
|
828
920
|
# Retrieves tax registration for a single account.
|
829
921
|
#
|
830
922
|
# @option params [String] :account_id
|
@@ -905,7 +997,7 @@ module Aws::TaxSettings
|
|
905
997
|
# Downloads your tax documents to the Amazon S3 bucket that you specify
|
906
998
|
# in your request.
|
907
999
|
#
|
908
|
-
# @option params [
|
1000
|
+
# @option params [Types::DestinationS3Location] :destination_s3_location
|
909
1001
|
# The Amazon S3 bucket that you specify to download your tax documents
|
910
1002
|
# to.
|
911
1003
|
#
|
@@ -915,11 +1007,12 @@ module Aws::TaxSettings
|
|
915
1007
|
# @return [Types::GetTaxRegistrationDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
916
1008
|
#
|
917
1009
|
# * {Types::GetTaxRegistrationDocumentResponse#destination_file_path #destination_file_path} => String
|
1010
|
+
# * {Types::GetTaxRegistrationDocumentResponse#presigned_s3_url #presigned_s3_url} => String
|
918
1011
|
#
|
919
1012
|
# @example Request syntax with placeholder values
|
920
1013
|
#
|
921
1014
|
# resp = client.get_tax_registration_document({
|
922
|
-
# destination_s3_location: {
|
1015
|
+
# destination_s3_location: {
|
923
1016
|
# bucket: "S3BucketName", # required
|
924
1017
|
# prefix: "S3Prefix",
|
925
1018
|
# },
|
@@ -932,6 +1025,7 @@ module Aws::TaxSettings
|
|
932
1025
|
# @example Response structure
|
933
1026
|
#
|
934
1027
|
# resp.destination_file_path #=> String
|
1028
|
+
# resp.presigned_s3_url #=> String
|
935
1029
|
#
|
936
1030
|
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/GetTaxRegistrationDocument AWS API Documentation
|
937
1031
|
#
|
@@ -991,6 +1085,58 @@ module Aws::TaxSettings
|
|
991
1085
|
req.send_request(options)
|
992
1086
|
end
|
993
1087
|
|
1088
|
+
# Retrieves the tax exemption of accounts listed in a consolidated
|
1089
|
+
# billing family.
|
1090
|
+
#
|
1091
|
+
# @option params [Integer] :max_results
|
1092
|
+
# The number of results you want in one response.
|
1093
|
+
#
|
1094
|
+
# @option params [String] :next_token
|
1095
|
+
# The token to retrieve the next set of results.
|
1096
|
+
#
|
1097
|
+
# @return [Types::ListTaxExemptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1098
|
+
#
|
1099
|
+
# * {Types::ListTaxExemptionsResponse#next_token #next_token} => String
|
1100
|
+
# * {Types::ListTaxExemptionsResponse#tax_exemption_details_map #tax_exemption_details_map} => Hash<String,Types::TaxExemptionDetails>
|
1101
|
+
#
|
1102
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1103
|
+
#
|
1104
|
+
# @example Request syntax with placeholder values
|
1105
|
+
#
|
1106
|
+
# resp = client.list_tax_exemptions({
|
1107
|
+
# max_results: 1,
|
1108
|
+
# next_token: "PaginationTokenString",
|
1109
|
+
# })
|
1110
|
+
#
|
1111
|
+
# @example Response structure
|
1112
|
+
#
|
1113
|
+
# resp.next_token #=> String
|
1114
|
+
# resp.tax_exemption_details_map #=> Hash
|
1115
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_details #=> Boolean
|
1116
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_parent_entity #=> String
|
1117
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_reason #=> String
|
1118
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions #=> Array
|
1119
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].authority.country #=> String
|
1120
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].authority.state #=> String
|
1121
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].effective_date #=> Time
|
1122
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].expiration_date #=> Time
|
1123
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].status #=> String, one of "None", "Valid", "Expired", "Pending"
|
1124
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].system_effective_date #=> Time
|
1125
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions #=> Array
|
1126
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions[0].country #=> String
|
1127
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions[0].state #=> String
|
1128
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.description #=> String
|
1129
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.display_name #=> String
|
1130
|
+
#
|
1131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/ListTaxExemptions AWS API Documentation
|
1132
|
+
#
|
1133
|
+
# @overload list_tax_exemptions(params = {})
|
1134
|
+
# @param [Hash] params ({})
|
1135
|
+
def list_tax_exemptions(params = {}, options = {})
|
1136
|
+
req = build_request(:list_tax_exemptions, params)
|
1137
|
+
req.send_request(options)
|
1138
|
+
end
|
1139
|
+
|
994
1140
|
# Retrieves the tax registration of accounts listed in a consolidated
|
995
1141
|
# billing family. This can be used to retrieve up to 100 accounts' tax
|
996
1142
|
# registrations in one call (default 50).
|
@@ -1135,6 +1281,75 @@ module Aws::TaxSettings
|
|
1135
1281
|
req.send_request(options)
|
1136
1282
|
end
|
1137
1283
|
|
1284
|
+
# Adds the tax exemption for a single account or all accounts listed in
|
1285
|
+
# a consolidated billing family.
|
1286
|
+
#
|
1287
|
+
# @option params [required, Array<String>] :account_ids
|
1288
|
+
# The list of unique account identifiers.
|
1289
|
+
#
|
1290
|
+
# @option params [required, Types::Authority] :authority
|
1291
|
+
# The address domain associate with the tax information.
|
1292
|
+
#
|
1293
|
+
# @option params [required, Types::ExemptionCertificate] :exemption_certificate
|
1294
|
+
# The exemption certificate.
|
1295
|
+
#
|
1296
|
+
# @option params [required, String] :exemption_type
|
1297
|
+
# The exemption type.
|
1298
|
+
#
|
1299
|
+
# @return [Types::PutTaxExemptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1300
|
+
#
|
1301
|
+
# * {Types::PutTaxExemptionResponse#case_id #case_id} => String
|
1302
|
+
#
|
1303
|
+
# @example Request syntax with placeholder values
|
1304
|
+
#
|
1305
|
+
# resp = client.put_tax_exemption({
|
1306
|
+
# account_ids: ["AccountId"], # required
|
1307
|
+
# authority: { # required
|
1308
|
+
# country: "CountryCode", # required
|
1309
|
+
# state: "State",
|
1310
|
+
# },
|
1311
|
+
# exemption_certificate: { # required
|
1312
|
+
# document_file: "data", # required
|
1313
|
+
# document_name: "ExemptionDocumentName", # required
|
1314
|
+
# },
|
1315
|
+
# exemption_type: "GenericString", # required
|
1316
|
+
# })
|
1317
|
+
#
|
1318
|
+
# @example Response structure
|
1319
|
+
#
|
1320
|
+
# resp.case_id #=> String
|
1321
|
+
#
|
1322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/PutTaxExemption AWS API Documentation
|
1323
|
+
#
|
1324
|
+
# @overload put_tax_exemption(params = {})
|
1325
|
+
# @param [Hash] params ({})
|
1326
|
+
def put_tax_exemption(params = {}, options = {})
|
1327
|
+
req = build_request(:put_tax_exemption, params)
|
1328
|
+
req.send_request(options)
|
1329
|
+
end
|
1330
|
+
|
1331
|
+
# The updated tax inheritance status.
|
1332
|
+
#
|
1333
|
+
# @option params [String] :heritage_status
|
1334
|
+
# The tax inheritance status.
|
1335
|
+
#
|
1336
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1337
|
+
#
|
1338
|
+
# @example Request syntax with placeholder values
|
1339
|
+
#
|
1340
|
+
# resp = client.put_tax_inheritance({
|
1341
|
+
# heritage_status: "OptIn", # accepts OptIn, OptOut
|
1342
|
+
# })
|
1343
|
+
#
|
1344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/PutTaxInheritance AWS API Documentation
|
1345
|
+
#
|
1346
|
+
# @overload put_tax_inheritance(params = {})
|
1347
|
+
# @param [Hash] params ({})
|
1348
|
+
def put_tax_inheritance(params = {}, options = {})
|
1349
|
+
req = build_request(:put_tax_inheritance, params)
|
1350
|
+
req.send_request(options)
|
1351
|
+
end
|
1352
|
+
|
1138
1353
|
# Adds or updates tax registration for a single account. You can't set
|
1139
1354
|
# a TRN if there's a pending TRN. You'll need to delete the pending
|
1140
1355
|
# TRN first.
|
@@ -1275,7 +1490,6 @@ module Aws::TaxSettings
|
|
1275
1490
|
#
|
1276
1491
|
# * **Note:** In the **Tax Settings** page of the Billing console,
|
1277
1492
|
# `Government` appears as **Public institutions**
|
1278
|
-
#
|
1279
1493
|
# * If your `sector` is `Business` and you're subject to KDV tax, you
|
1280
1494
|
# must specify your industry in the `industries` field.
|
1281
1495
|
#
|
@@ -1385,7 +1599,11 @@ module Aws::TaxSettings
|
|
1385
1599
|
# date_of_birth: "DateOfBirth",
|
1386
1600
|
# tax_registration_documents: [
|
1387
1601
|
# {
|
1388
|
-
#
|
1602
|
+
# file: {
|
1603
|
+
# file_content: "data", # required
|
1604
|
+
# file_name: "TaxDocumentName", # required
|
1605
|
+
# },
|
1606
|
+
# s3_location: {
|
1389
1607
|
# bucket: "S3BucketName", # required
|
1390
1608
|
# key: "S3Key", # required
|
1391
1609
|
# },
|
@@ -1426,7 +1644,7 @@ module Aws::TaxSettings
|
|
1426
1644
|
tracer: tracer
|
1427
1645
|
)
|
1428
1646
|
context[:gem_name] = 'aws-sdk-taxsettings'
|
1429
|
-
context[:gem_version] = '1.
|
1647
|
+
context[:gem_version] = '1.15.0'
|
1430
1648
|
Seahorse::Client::Request.new(handlers, context)
|
1431
1649
|
end
|
1432
1650
|
|