aws-sdk-invoicing 1.13.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54f2bef226a2480e49a244f08aa03e27afc2c7c5e49733568fab94533b4a429f
-  data.tar.gz: d4a6ab5b4e13ed83a1f1c1bea5f748f017dff874353d0d02a56d15017235e4dd
+  metadata.gz: 3fbdf832bfa5b930cb0d429d120e6adb4e4c0692cc8c0909e109abdfe9235f12
+  data.tar.gz: 63f05397151382d78cb91c2314de338b19cff7f782362b40f5ffc3befbb13b7c
 SHA512:
-  metadata.gz: 9836e437bce8b5a53a0a0f20010b92951ddee35f079d3d302c74a231ee00b047513c3117d5ce7c3076e9b83248ba8e3a91af700d2b62d7e83a36436acfda5e12
-  data.tar.gz: 8de86583baa7f68588174fc53f2a381e49266b2546fb69ebd2077621c3a4dac0b06b0c2b5134dce7bce3ac0ec12e071ce1230ee8908b18cc99ccff05437e61f0
+  metadata.gz: fe3299ad1045376db3d8f7f5dd602a615415ef931efe66ca5f66fef668d6c67f5eedf1fa13fc01aec93ab8aef94667f8f337e1e2a8edcb28a9a86a89379e114e
+  data.tar.gz: 56732ea0b21e86744f9d538860e36e6dc0a2c5eb790ffabd6721aa55d1536797c64e025b3eabebb4ce6d83488dd928204440325abd1cb7a7eec2afe8726ac6e3

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.15.0 (2025-11-10)
+------------------
+
+* Feature - Added new invoicing get-invoice-pdf API Operation
+
+1.14.0 (2025-10-27)
+------------------
+
+* Feature - Update endpoint ruleset parameters casing
+
 1.13.0 (2025-10-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.13.0
+1.15.0

data/lib/aws-sdk-invoicing/client.rb

@@ -683,6 +683,85 @@ module Aws::Invoicing
       req.send_request(options)
     end
 
+    # Returns a URL to download the invoice document and supplemental
+    # documents associated with an invoice. The URLs are pre-signed and have
+    # expiration time. For special cases like Brazil, where Amazon Web
+    # Services generated invoice identifiers and government provided
+    # identifiers do not match, use the Amazon Web Services generated
+    # invoice identifier when making API requests. To grant IAM permission
+    # to use this operation, the caller needs the `invoicing:GetInvoicePDF`
+    # policy action.
+    #
+    # @option params [required, String] :invoice_id
+    #   Your unique invoice ID.
+    #
+    # @return [Types::GetInvoicePDFResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetInvoicePDFResponse#invoice_pdf #invoice_pdf} => Types::InvoicePDF
+    #
+    #
+    # @example Example: GetInvoicePDF without supplemental documents
+    #
+    #   resp = client.get_invoice_pdf({
+    #     invoice_id: "abc123", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     invoice_pdf: {
+    #       document_url: "https://abcd123.com?securityTokenForDoc", 
+    #       document_url_expiration_date: Time.parse("2025-04-01T01:00:00.000Z"), 
+    #       invoice_id: "abc123", 
+    #       supplemental_documents: [
+    #       ], 
+    #     }, 
+    #   }
+    #
+    # @example Example: GetInvoicePDF with supplemental documents
+    #
+    #   resp = client.get_invoice_pdf({
+    #     invoice_id: "abc123", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     invoice_pdf: {
+    #       document_url: "https://abcd123.com?securityTokenForDoc", 
+    #       document_url_expiration_date: Time.parse("2025-04-01T01:00:00.000Z"), 
+    #       invoice_id: "abc123", 
+    #       supplemental_documents: [
+    #         {
+    #           document_url: "https://abcd123.com?securityTokenForSupplementalDoc", 
+    #           document_url_expiration_date: Time.parse("2025-04-01T01:00:00.000Z"), 
+    #         }, 
+    #       ], 
+    #     }, 
+    #   }
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_invoice_pdf({
+    #     invoice_id: "StringWithoutNewLine", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.invoice_pdf.invoice_id #=> String
+    #   resp.invoice_pdf.document_url #=> String
+    #   resp.invoice_pdf.document_url_expiration_date #=> Time
+    #   resp.invoice_pdf.supplemental_documents #=> Array
+    #   resp.invoice_pdf.supplemental_documents[0].document_url #=> String
+    #   resp.invoice_pdf.supplemental_documents[0].document_url_expiration_date #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/GetInvoicePDF AWS API Documentation
+    #
+    # @overload get_invoice_pdf(params = {})
+    # @param [Hash] params ({})
+    def get_invoice_pdf(params = {}, options = {})
+      req = build_request(:get_invoice_pdf, params)
+      req.send_request(options)
+    end
+
     # This retrieves the invoice unit definition.
     #
     # @option params [required, String] :invoice_unit_arn
@@ -1834,7 +1913,7 @@ module Aws::Invoicing
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-invoicing'
-      context[:gem_version] = '1.13.0'
+      context[:gem_version] = '1.15.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-invoicing/client_api.rb

@@ -40,11 +40,14 @@ module Aws::Invoicing
     FeesBreakdownAmount = Shapes::StructureShape.new(name: 'FeesBreakdownAmount')
     FeesBreakdownAmountList = Shapes::ListShape.new(name: 'FeesBreakdownAmountList')
     Filters = Shapes::StructureShape.new(name: 'Filters')
+    GetInvoicePDFRequest = Shapes::StructureShape.new(name: 'GetInvoicePDFRequest')
+    GetInvoicePDFResponse = Shapes::StructureShape.new(name: 'GetInvoicePDFResponse')
     GetInvoiceUnitRequest = Shapes::StructureShape.new(name: 'GetInvoiceUnitRequest')
     GetInvoiceUnitResponse = Shapes::StructureShape.new(name: 'GetInvoiceUnitResponse')
     Integer = Shapes::IntegerShape.new(name: 'Integer')
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
     InvoiceCurrencyAmount = Shapes::StructureShape.new(name: 'InvoiceCurrencyAmount')
+    InvoicePDF = Shapes::StructureShape.new(name: 'InvoicePDF')
     InvoiceProfile = Shapes::StructureShape.new(name: 'InvoiceProfile')
     InvoiceSummaries = Shapes::ListShape.new(name: 'InvoiceSummaries')
     InvoiceSummariesFilter = Shapes::StructureShape.new(name: 'InvoiceSummariesFilter')
@@ -80,6 +83,8 @@ module Aws::Invoicing
     SensitiveBasicStringWithoutSpace = Shapes::StringShape.new(name: 'SensitiveBasicStringWithoutSpace')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
     StringWithoutNewLine = Shapes::StringShape.new(name: 'StringWithoutNewLine')
+    SupplementalDocument = Shapes::StructureShape.new(name: 'SupplementalDocument')
+    SupplementalDocuments = Shapes::ListShape.new(name: 'SupplementalDocuments')
     TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
     TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
     TagrisArn = Shapes::StringShape.new(name: 'TagrisArn')
@@ -177,6 +182,12 @@ module Aws::Invoicing
     Filters.add_member(:accounts, Shapes::ShapeRef.new(shape: AccountIdList, location_name: "Accounts"))
     Filters.struct_class = Types::Filters
 
+    GetInvoicePDFRequest.add_member(:invoice_id, Shapes::ShapeRef.new(shape: StringWithoutNewLine, required: true, location_name: "InvoiceId"))
+    GetInvoicePDFRequest.struct_class = Types::GetInvoicePDFRequest
+
+    GetInvoicePDFResponse.add_member(:invoice_pdf, Shapes::ShapeRef.new(shape: InvoicePDF, location_name: "InvoicePDF"))
+    GetInvoicePDFResponse.struct_class = Types::GetInvoicePDFResponse
+
     GetInvoiceUnitRequest.add_member(:invoice_unit_arn, Shapes::ShapeRef.new(shape: InvoiceUnitArnString, required: true, location_name: "InvoiceUnitArn"))
     GetInvoiceUnitRequest.add_member(:as_of, Shapes::ShapeRef.new(shape: AsOfTimestamp, location_name: "AsOf"))
     GetInvoiceUnitRequest.struct_class = Types::GetInvoiceUnitRequest
@@ -201,6 +212,12 @@ module Aws::Invoicing
     InvoiceCurrencyAmount.add_member(:currency_exchange_details, Shapes::ShapeRef.new(shape: CurrencyExchangeDetails, location_name: "CurrencyExchangeDetails"))
     InvoiceCurrencyAmount.struct_class = Types::InvoiceCurrencyAmount
 
+    InvoicePDF.add_member(:invoice_id, Shapes::ShapeRef.new(shape: StringWithoutNewLine, location_name: "InvoiceId"))
+    InvoicePDF.add_member(:document_url, Shapes::ShapeRef.new(shape: StringWithoutNewLine, location_name: "DocumentUrl"))
+    InvoicePDF.add_member(:document_url_expiration_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "DocumentUrlExpirationDate"))
+    InvoicePDF.add_member(:supplemental_documents, Shapes::ShapeRef.new(shape: SupplementalDocuments, location_name: "SupplementalDocuments"))
+    InvoicePDF.struct_class = Types::InvoicePDF
+
     InvoiceProfile.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountIdString, location_name: "AccountId"))
     InvoiceProfile.add_member(:receiver_name, Shapes::ShapeRef.new(shape: BasicStringWithoutSpace, location_name: "ReceiverName"))
     InvoiceProfile.add_member(:receiver_address, Shapes::ShapeRef.new(shape: ReceiverAddress, location_name: "ReceiverAddress"))
@@ -304,6 +321,12 @@ module Aws::Invoicing
     ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: BasicString, required: true, location_name: "message"))
     ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
 
+    SupplementalDocument.add_member(:document_url, Shapes::ShapeRef.new(shape: StringWithoutNewLine, location_name: "DocumentUrl"))
+    SupplementalDocument.add_member(:document_url_expiration_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "DocumentUrlExpirationDate"))
+    SupplementalDocument.struct_class = Types::SupplementalDocument
+
+    SupplementalDocuments.member = Shapes::ShapeRef.new(shape: SupplementalDocument)
+
     TagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: TagrisArn, required: true, location_name: "ResourceArn"))
     TagResourceRequest.add_member(:resource_tags, Shapes::ShapeRef.new(shape: ResourceTagList, required: true, location_name: "ResourceTags"))
     TagResourceRequest.struct_class = Types::TagResourceRequest
@@ -410,6 +433,19 @@ module Aws::Invoicing
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
       end)
 
+      api.add_operation(:get_invoice_pdf, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetInvoicePDF"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: GetInvoicePDFRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetInvoicePDFResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+      end)
+
       api.add_operation(:get_invoice_unit, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetInvoiceUnit"
         o.http_method = "POST"

data/lib/aws-sdk-invoicing/endpoint_parameters.rb

@@ -13,17 +13,17 @@ module Aws::Invoicing
   # @!attribute use_fips
   #   When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
   #
-  #   @return [Boolean]
+  #   @return [boolean]
   #
   # @!attribute endpoint
   #   Override the endpoint used to send this request
   #
-  #   @return [String]
+  #   @return [string]
   #
   # @!attribute region
   #   The AWS region used to dispatch the request.
   #
-  #   @return [String]
+  #   @return [string]
   #
   EndpointParameters = Struct.new(
     :use_fips,

data/lib/aws-sdk-invoicing/types.rb

@@ -375,6 +375,31 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # @!attribute [rw] invoice_id
+    #   Your unique invoice ID.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/GetInvoicePDFRequest AWS API Documentation
+    #
+    class GetInvoicePDFRequest < Struct.new(
+      :invoice_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] invoice_pdf
+    #   The invoice document and supplemental documents associated with the
+    #   invoice.
+    #   @return [Types::InvoicePDF]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/GetInvoicePDFResponse AWS API Documentation
+    #
+    class GetInvoicePDFResponse < Struct.new(
+      :invoice_pdf)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] invoice_unit_arn
     #   The ARN to identify an invoice unit. This information can't be
     #   modified or deleted.
@@ -499,6 +524,35 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # Invoice document data.
+    #
+    # @!attribute [rw] invoice_id
+    #   Your unique invoice ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_url
+    #   The pre-signed URL to download the invoice document.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_url_expiration_date
+    #   The pre-signed URL expiration date of the invoice document.
+    #   @return [Time]
+    #
+    # @!attribute [rw] supplemental_documents
+    #   List of supplemental documents associated with the invoice.
+    #   @return [Array<Types::SupplementalDocument>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/InvoicePDF AWS API Documentation
+    #
+    class InvoicePDF < Struct.new(
+      :invoice_id,
+      :document_url,
+      :document_url_expiration_date,
+      :supplemental_documents)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains high-level information about the invoice receiver.
     #
     # @!attribute [rw] account_id
@@ -955,6 +1009,25 @@ module Aws::Invoicing
       include Aws::Structure
     end
 
+    # Supplemental document associated with the invoice.
+    #
+    # @!attribute [rw] document_url
+    #   The pre-signed URL to download invoice supplemental document.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_url_expiration_date
+    #   The pre-signed URL expiration date of invoice supplemental document.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/invoicing-2024-12-01/SupplementalDocument AWS API Documentation
+    #
+    class SupplementalDocument < Struct.new(
+      :document_url,
+      :document_url_expiration_date)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] resource_arn
     #   The Amazon Resource Name (ARN) of the tags.
     #   @return [String]

data/lib/aws-sdk-invoicing.rb

@@ -55,7 +55,7 @@ module Aws::Invoicing
   autoload :EndpointProvider, 'aws-sdk-invoicing/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-invoicing/endpoints'
 
-  GEM_VERSION = '1.13.0'
+  GEM_VERSION = '1.15.0'
 
 end
 

data/sig/client.rbs

@@ -121,6 +121,16 @@ module Aws
                                ) -> _DeleteInvoiceUnitResponseSuccess
                              | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteInvoiceUnitResponseSuccess
 
+      interface _GetInvoicePDFResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetInvoicePDFResponse]
+        def invoice_pdf: () -> Types::InvoicePDF
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Invoicing/Client.html#get_invoice_pdf-instance_method
+      def get_invoice_pdf: (
+                             invoice_id: ::String
+                           ) -> _GetInvoicePDFResponseSuccess
+                         | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetInvoicePDFResponseSuccess
+
       interface _GetInvoiceUnitResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::GetInvoiceUnitResponse]
         def invoice_unit_arn: () -> ::String

data/sig/types.rbs

@@ -114,6 +114,16 @@ module Aws::Invoicing
       SENSITIVE: []
     end
 
+    class GetInvoicePDFRequest
+      attr_accessor invoice_id: ::String
+      SENSITIVE: []
+    end
+
+    class GetInvoicePDFResponse
+      attr_accessor invoice_pdf: Types::InvoicePDF
+      SENSITIVE: []
+    end
+
     class GetInvoiceUnitRequest
       attr_accessor invoice_unit_arn: ::String
       attr_accessor as_of: ::Time
@@ -146,6 +156,14 @@ module Aws::Invoicing
       SENSITIVE: []
     end
 
+    class InvoicePDF
+      attr_accessor invoice_id: ::String
+      attr_accessor document_url: ::String
+      attr_accessor document_url_expiration_date: ::Time
+      attr_accessor supplemental_documents: ::Array[Types::SupplementalDocument]
+      SENSITIVE: []
+    end
+
     class InvoiceProfile
       attr_accessor account_id: ::String
       attr_accessor receiver_name: ::String
@@ -269,6 +287,12 @@ module Aws::Invoicing
       SENSITIVE: []
     end
 
+    class SupplementalDocument
+      attr_accessor document_url: ::String
+      attr_accessor document_url_expiration_date: ::Time
+      SENSITIVE: []
+    end
+
     class TagResourceRequest
       attr_accessor resource_arn: ::String
       attr_accessor resource_tags: ::Array[Types::ResourceTag]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-invoicing
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Amazon Web Services