aws-sdk-taxsettings 1.14.0 → 1.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-taxsettings/client.rb +248 -5
- 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 +83 -3
- data/sig/errors.rbs +9 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +120 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b544e80f70fa8f23bb47ffea894c906e758b8ebea5f1547014aa4322b0a057f3
|
4
|
+
data.tar.gz: de1425e787bd0b96bbf05420fd8236c78f4a61e92cd1e72c74104052ae807f93
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b166cffc89dc246e853767de581fccc49113204b9eb955434eb0b4981103efd617d5ba1b4622f694f7672ac7d8e3891a35bdb00882c5bfb92c664078bc2bf1f3
|
7
|
+
data.tar.gz: 6e776c93c1d6edeb4cc3c8b44eab1ba353c45df92e725e1427f63729df7f7da301f84851ed11141ced8be8c17575f3b636fe60834bb7c945479a5144801a596a
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.16.0 (2025-01-15)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.15.0 (2024-11-19)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Release Tax Inheritance APIs, Tax Exemption APIs, and functionality update for some existing Tax Registration APIs
|
13
|
+
|
4
14
|
1.14.0 (2024-11-18)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.16.0
|
@@ -257,11 +257,34 @@ module Aws::TaxSettings
|
|
257
257
|
# Used when loading credentials from the shared credentials file
|
258
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
260
272
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
273
|
# The minimum size in bytes that triggers compression for request
|
262
274
|
# bodies. The value must be non-negative integer value between 0
|
263
275
|
# and 10485780 bytes inclusive.
|
264
276
|
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
265
288
|
# @option options [Proc] :retry_backoff
|
266
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -489,6 +512,52 @@ module Aws::TaxSettings
|
|
489
512
|
req.send_request(options)
|
490
513
|
end
|
491
514
|
|
515
|
+
# Get the active tax exemptions for a given list of accounts.
|
516
|
+
#
|
517
|
+
# @option params [required, Array<String>] :account_ids
|
518
|
+
# List of unique account identifiers.
|
519
|
+
#
|
520
|
+
# @return [Types::BatchGetTaxExemptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
521
|
+
#
|
522
|
+
# * {Types::BatchGetTaxExemptionsResponse#failed_accounts #failed_accounts} => Array<String>
|
523
|
+
# * {Types::BatchGetTaxExemptionsResponse#tax_exemption_details_map #tax_exemption_details_map} => Hash<String,Types::TaxExemptionDetails>
|
524
|
+
#
|
525
|
+
# @example Request syntax with placeholder values
|
526
|
+
#
|
527
|
+
# resp = client.batch_get_tax_exemptions({
|
528
|
+
# account_ids: ["AccountId"], # required
|
529
|
+
# })
|
530
|
+
#
|
531
|
+
# @example Response structure
|
532
|
+
#
|
533
|
+
# resp.failed_accounts #=> Array
|
534
|
+
# resp.failed_accounts[0] #=> String
|
535
|
+
# resp.tax_exemption_details_map #=> Hash
|
536
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_details #=> Boolean
|
537
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_parent_entity #=> String
|
538
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_reason #=> String
|
539
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions #=> Array
|
540
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].authority.country #=> String
|
541
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].authority.state #=> String
|
542
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].effective_date #=> Time
|
543
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].expiration_date #=> Time
|
544
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].status #=> String, one of "None", "Valid", "Expired", "Pending"
|
545
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].system_effective_date #=> Time
|
546
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions #=> Array
|
547
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions[0].country #=> String
|
548
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions[0].state #=> String
|
549
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.description #=> String
|
550
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.display_name #=> String
|
551
|
+
#
|
552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/BatchGetTaxExemptions AWS API Documentation
|
553
|
+
#
|
554
|
+
# @overload batch_get_tax_exemptions(params = {})
|
555
|
+
# @param [Hash] params ({})
|
556
|
+
def batch_get_tax_exemptions(params = {}, options = {})
|
557
|
+
req = build_request(:batch_get_tax_exemptions, params)
|
558
|
+
req.send_request(options)
|
559
|
+
end
|
560
|
+
|
492
561
|
# Adds or updates tax registration for multiple accounts in batch. This
|
493
562
|
# can be used to add or update tax registrations for up to five accounts
|
494
563
|
# in one batch. You can't set a TRN if there's a pending TRN. You'll
|
@@ -740,7 +809,11 @@ module Aws::TaxSettings
|
|
740
809
|
# date_of_birth: "DateOfBirth",
|
741
810
|
# tax_registration_documents: [
|
742
811
|
# {
|
743
|
-
#
|
812
|
+
# file: {
|
813
|
+
# file_content: "data", # required
|
814
|
+
# file_name: "TaxDocumentName", # required
|
815
|
+
# },
|
816
|
+
# s3_location: {
|
744
817
|
# bucket: "S3BucketName", # required
|
745
818
|
# key: "S3Key", # required
|
746
819
|
# },
|
@@ -824,6 +897,49 @@ module Aws::TaxSettings
|
|
824
897
|
req.send_request(options)
|
825
898
|
end
|
826
899
|
|
900
|
+
# Get supported tax exemption types.
|
901
|
+
#
|
902
|
+
# @return [Types::GetTaxExemptionTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
903
|
+
#
|
904
|
+
# * {Types::GetTaxExemptionTypesResponse#tax_exemption_types #tax_exemption_types} => Array<Types::TaxExemptionType>
|
905
|
+
#
|
906
|
+
# @example Response structure
|
907
|
+
#
|
908
|
+
# resp.tax_exemption_types #=> Array
|
909
|
+
# resp.tax_exemption_types[0].applicable_jurisdictions #=> Array
|
910
|
+
# resp.tax_exemption_types[0].applicable_jurisdictions[0].country #=> String
|
911
|
+
# resp.tax_exemption_types[0].applicable_jurisdictions[0].state #=> String
|
912
|
+
# resp.tax_exemption_types[0].description #=> String
|
913
|
+
# resp.tax_exemption_types[0].display_name #=> String
|
914
|
+
#
|
915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/GetTaxExemptionTypes AWS API Documentation
|
916
|
+
#
|
917
|
+
# @overload get_tax_exemption_types(params = {})
|
918
|
+
# @param [Hash] params ({})
|
919
|
+
def get_tax_exemption_types(params = {}, options = {})
|
920
|
+
req = build_request(:get_tax_exemption_types, params)
|
921
|
+
req.send_request(options)
|
922
|
+
end
|
923
|
+
|
924
|
+
# The get account tax inheritance status.
|
925
|
+
#
|
926
|
+
# @return [Types::GetTaxInheritanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
927
|
+
#
|
928
|
+
# * {Types::GetTaxInheritanceResponse#heritage_status #heritage_status} => String
|
929
|
+
#
|
930
|
+
# @example Response structure
|
931
|
+
#
|
932
|
+
# resp.heritage_status #=> String, one of "OptIn", "OptOut"
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/GetTaxInheritance AWS API Documentation
|
935
|
+
#
|
936
|
+
# @overload get_tax_inheritance(params = {})
|
937
|
+
# @param [Hash] params ({})
|
938
|
+
def get_tax_inheritance(params = {}, options = {})
|
939
|
+
req = build_request(:get_tax_inheritance, params)
|
940
|
+
req.send_request(options)
|
941
|
+
end
|
942
|
+
|
827
943
|
# Retrieves tax registration for a single account.
|
828
944
|
#
|
829
945
|
# @option params [String] :account_id
|
@@ -904,7 +1020,7 @@ module Aws::TaxSettings
|
|
904
1020
|
# Downloads your tax documents to the Amazon S3 bucket that you specify
|
905
1021
|
# in your request.
|
906
1022
|
#
|
907
|
-
# @option params [
|
1023
|
+
# @option params [Types::DestinationS3Location] :destination_s3_location
|
908
1024
|
# The Amazon S3 bucket that you specify to download your tax documents
|
909
1025
|
# to.
|
910
1026
|
#
|
@@ -914,11 +1030,12 @@ module Aws::TaxSettings
|
|
914
1030
|
# @return [Types::GetTaxRegistrationDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
915
1031
|
#
|
916
1032
|
# * {Types::GetTaxRegistrationDocumentResponse#destination_file_path #destination_file_path} => String
|
1033
|
+
# * {Types::GetTaxRegistrationDocumentResponse#presigned_s3_url #presigned_s3_url} => String
|
917
1034
|
#
|
918
1035
|
# @example Request syntax with placeholder values
|
919
1036
|
#
|
920
1037
|
# resp = client.get_tax_registration_document({
|
921
|
-
# destination_s3_location: {
|
1038
|
+
# destination_s3_location: {
|
922
1039
|
# bucket: "S3BucketName", # required
|
923
1040
|
# prefix: "S3Prefix",
|
924
1041
|
# },
|
@@ -931,6 +1048,7 @@ module Aws::TaxSettings
|
|
931
1048
|
# @example Response structure
|
932
1049
|
#
|
933
1050
|
# resp.destination_file_path #=> String
|
1051
|
+
# resp.presigned_s3_url #=> String
|
934
1052
|
#
|
935
1053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/GetTaxRegistrationDocument AWS API Documentation
|
936
1054
|
#
|
@@ -990,6 +1108,58 @@ module Aws::TaxSettings
|
|
990
1108
|
req.send_request(options)
|
991
1109
|
end
|
992
1110
|
|
1111
|
+
# Retrieves the tax exemption of accounts listed in a consolidated
|
1112
|
+
# billing family.
|
1113
|
+
#
|
1114
|
+
# @option params [Integer] :max_results
|
1115
|
+
# The number of results you want in one response.
|
1116
|
+
#
|
1117
|
+
# @option params [String] :next_token
|
1118
|
+
# The token to retrieve the next set of results.
|
1119
|
+
#
|
1120
|
+
# @return [Types::ListTaxExemptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1121
|
+
#
|
1122
|
+
# * {Types::ListTaxExemptionsResponse#next_token #next_token} => String
|
1123
|
+
# * {Types::ListTaxExemptionsResponse#tax_exemption_details_map #tax_exemption_details_map} => Hash<String,Types::TaxExemptionDetails>
|
1124
|
+
#
|
1125
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1126
|
+
#
|
1127
|
+
# @example Request syntax with placeholder values
|
1128
|
+
#
|
1129
|
+
# resp = client.list_tax_exemptions({
|
1130
|
+
# max_results: 1,
|
1131
|
+
# next_token: "PaginationTokenString",
|
1132
|
+
# })
|
1133
|
+
#
|
1134
|
+
# @example Response structure
|
1135
|
+
#
|
1136
|
+
# resp.next_token #=> String
|
1137
|
+
# resp.tax_exemption_details_map #=> Hash
|
1138
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_details #=> Boolean
|
1139
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_parent_entity #=> String
|
1140
|
+
# resp.tax_exemption_details_map["AccountId"].heritage_obtained_reason #=> String
|
1141
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions #=> Array
|
1142
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].authority.country #=> String
|
1143
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].authority.state #=> String
|
1144
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].effective_date #=> Time
|
1145
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].expiration_date #=> Time
|
1146
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].status #=> String, one of "None", "Valid", "Expired", "Pending"
|
1147
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].system_effective_date #=> Time
|
1148
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions #=> Array
|
1149
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions[0].country #=> String
|
1150
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.applicable_jurisdictions[0].state #=> String
|
1151
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.description #=> String
|
1152
|
+
# resp.tax_exemption_details_map["AccountId"].tax_exemptions[0].tax_exemption_type.display_name #=> String
|
1153
|
+
#
|
1154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/ListTaxExemptions AWS API Documentation
|
1155
|
+
#
|
1156
|
+
# @overload list_tax_exemptions(params = {})
|
1157
|
+
# @param [Hash] params ({})
|
1158
|
+
def list_tax_exemptions(params = {}, options = {})
|
1159
|
+
req = build_request(:list_tax_exemptions, params)
|
1160
|
+
req.send_request(options)
|
1161
|
+
end
|
1162
|
+
|
993
1163
|
# Retrieves the tax registration of accounts listed in a consolidated
|
994
1164
|
# billing family. This can be used to retrieve up to 100 accounts' tax
|
995
1165
|
# registrations in one call (default 50).
|
@@ -1134,6 +1304,75 @@ module Aws::TaxSettings
|
|
1134
1304
|
req.send_request(options)
|
1135
1305
|
end
|
1136
1306
|
|
1307
|
+
# Adds the tax exemption for a single account or all accounts listed in
|
1308
|
+
# a consolidated billing family.
|
1309
|
+
#
|
1310
|
+
# @option params [required, Array<String>] :account_ids
|
1311
|
+
# The list of unique account identifiers.
|
1312
|
+
#
|
1313
|
+
# @option params [required, Types::Authority] :authority
|
1314
|
+
# The address domain associate with the tax information.
|
1315
|
+
#
|
1316
|
+
# @option params [required, Types::ExemptionCertificate] :exemption_certificate
|
1317
|
+
# The exemption certificate.
|
1318
|
+
#
|
1319
|
+
# @option params [required, String] :exemption_type
|
1320
|
+
# The exemption type.
|
1321
|
+
#
|
1322
|
+
# @return [Types::PutTaxExemptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1323
|
+
#
|
1324
|
+
# * {Types::PutTaxExemptionResponse#case_id #case_id} => String
|
1325
|
+
#
|
1326
|
+
# @example Request syntax with placeholder values
|
1327
|
+
#
|
1328
|
+
# resp = client.put_tax_exemption({
|
1329
|
+
# account_ids: ["AccountId"], # required
|
1330
|
+
# authority: { # required
|
1331
|
+
# country: "CountryCode", # required
|
1332
|
+
# state: "State",
|
1333
|
+
# },
|
1334
|
+
# exemption_certificate: { # required
|
1335
|
+
# document_file: "data", # required
|
1336
|
+
# document_name: "ExemptionDocumentName", # required
|
1337
|
+
# },
|
1338
|
+
# exemption_type: "GenericString", # required
|
1339
|
+
# })
|
1340
|
+
#
|
1341
|
+
# @example Response structure
|
1342
|
+
#
|
1343
|
+
# resp.case_id #=> String
|
1344
|
+
#
|
1345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/PutTaxExemption AWS API Documentation
|
1346
|
+
#
|
1347
|
+
# @overload put_tax_exemption(params = {})
|
1348
|
+
# @param [Hash] params ({})
|
1349
|
+
def put_tax_exemption(params = {}, options = {})
|
1350
|
+
req = build_request(:put_tax_exemption, params)
|
1351
|
+
req.send_request(options)
|
1352
|
+
end
|
1353
|
+
|
1354
|
+
# The updated tax inheritance status.
|
1355
|
+
#
|
1356
|
+
# @option params [String] :heritage_status
|
1357
|
+
# The tax inheritance status.
|
1358
|
+
#
|
1359
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1360
|
+
#
|
1361
|
+
# @example Request syntax with placeholder values
|
1362
|
+
#
|
1363
|
+
# resp = client.put_tax_inheritance({
|
1364
|
+
# heritage_status: "OptIn", # accepts OptIn, OptOut
|
1365
|
+
# })
|
1366
|
+
#
|
1367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/taxsettings-2018-05-10/PutTaxInheritance AWS API Documentation
|
1368
|
+
#
|
1369
|
+
# @overload put_tax_inheritance(params = {})
|
1370
|
+
# @param [Hash] params ({})
|
1371
|
+
def put_tax_inheritance(params = {}, options = {})
|
1372
|
+
req = build_request(:put_tax_inheritance, params)
|
1373
|
+
req.send_request(options)
|
1374
|
+
end
|
1375
|
+
|
1137
1376
|
# Adds or updates tax registration for a single account. You can't set
|
1138
1377
|
# a TRN if there's a pending TRN. You'll need to delete the pending
|
1139
1378
|
# TRN first.
|
@@ -1383,7 +1622,11 @@ module Aws::TaxSettings
|
|
1383
1622
|
# date_of_birth: "DateOfBirth",
|
1384
1623
|
# tax_registration_documents: [
|
1385
1624
|
# {
|
1386
|
-
#
|
1625
|
+
# file: {
|
1626
|
+
# file_content: "data", # required
|
1627
|
+
# file_name: "TaxDocumentName", # required
|
1628
|
+
# },
|
1629
|
+
# s3_location: {
|
1387
1630
|
# bucket: "S3BucketName", # required
|
1388
1631
|
# key: "S3Key", # required
|
1389
1632
|
# },
|
@@ -1424,7 +1667,7 @@ module Aws::TaxSettings
|
|
1424
1667
|
tracer: tracer
|
1425
1668
|
)
|
1426
1669
|
context[:gem_name] = 'aws-sdk-taxsettings'
|
1427
|
-
context[:gem_version] = '1.
|
1670
|
+
context[:gem_version] = '1.16.0'
|
1428
1671
|
Seahorse::Client::Request.new(handlers, context)
|
1429
1672
|
end
|
1430
1673
|
|