@aws-sdk/client-invoicing 3.703.0 → 3.704.0

package/dist-types/commands/BatchGetInvoiceProfileCommand.d.ts

@@ -95,6 +95,38 @@ declare const BatchGetInvoiceProfileCommand_base: {
  * <p>Base exception class for all service exceptions from Invoicing service.</p>
  *
  * @public
+ * @example BatchGetInvoiceProfile
+ * ```javascript
+ * //
+ * const input = {
+ *   "AccountIds": [
+ *     "111111111111"
+ *   ]
+ * };
+ * const command = new BatchGetInvoiceProfileCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Profiles": [
+ *     {
+ *       "AccountId": "111111111111",
+ *       "Issuer": "Test",
+ *       "ReceiverAddress": {
+ *         "AddressLine1": "Test",
+ *         "City": "Test",
+ *         "CountryCode": "LU",
+ *         "PostalCode": "Test",
+ *         "StateOrRegion": "Test"
+ *       },
+ *       "ReceiverEmail": "test@amazon.com",
+ *       "ReceiverName": "TestAccount"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class BatchGetInvoiceProfileCommand extends BatchGetInvoiceProfileCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/CreateInvoiceUnitCommand.d.ts

@@ -84,6 +84,36 @@ declare const CreateInvoiceUnitCommand_base: {
  * <p>Base exception class for all service exceptions from Invoicing service.</p>
  *
  * @public
+ * @example CreateInvoiceUnit
+ * ```javascript
+ * //
+ * const input = {
+ *   "Description": "Example Invoice Unit Description",
+ *   "InvoiceReceiver": "111111111111",
+ *   "Name": "Example Invoice Unit",
+ *   "ResourceTags": [
+ *     {
+ *       "Key": "TagKey",
+ *       "Value": "TagValue"
+ *     }
+ *   ],
+ *   "Rule": {
+ *     "LinkedAccounts": [
+ *       "222222222222"
+ *     ]
+ *   },
+ *   "TaxInheritanceDisabled": false
+ * };
+ * const command = new CreateInvoiceUnitCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class CreateInvoiceUnitCommand extends CreateInvoiceUnitCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteInvoiceUnitCommand.d.ts

@@ -75,6 +75,22 @@ declare const DeleteInvoiceUnitCommand_base: {
  * <p>Base exception class for all service exceptions from Invoicing service.</p>
  *
  * @public
+ * @example DeleteInvoiceUnit
+ * ```javascript
+ * //
+ * const input = {
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678"
+ * };
+ * const command = new DeleteInvoiceUnitCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteInvoiceUnitCommand extends DeleteInvoiceUnitCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetInvoiceUnitCommand.d.ts

@@ -85,6 +85,59 @@ declare const GetInvoiceUnitCommand_base: {
  * <p>Base exception class for all service exceptions from Invoicing service.</p>
  *
  * @public
+ * @example GetInvoiceUnit as of current time
+ * ```javascript
+ * //
+ * const input = {
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678"
+ * };
+ * const command = new GetInvoiceUnitCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Description": "Description changed on 1733788800",
+ *   "InvoiceReceiver": "111111111111",
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678",
+ *   "LastModified": 1733788800,
+ *   "Name": "Example Invoice Unit A",
+ *   "Rule": {
+ *     "LinkedAccounts": [
+ *       "222222222222"
+ *     ]
+ *   },
+ *   "TaxInheritanceDisabled": false
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example GetInvoiceUnit as of specified time
+ * ```javascript
+ * //
+ * const input = {
+ *   "AsOf": 1733097600,
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321"
+ * };
+ * const command = new GetInvoiceUnitCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Description": "Description changed on 1733011200",
+ *   "InvoiceReceiver": "333333333333",
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321",
+ *   "LastModified": 1733011200,
+ *   "Name": "Example Invoice Unit B",
+ *   "Rule": {
+ *     "LinkedAccounts": [
+ *       "333333333333"
+ *     ]
+ *   },
+ *   "TaxInheritanceDisabled": false
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
  */
 export declare class GetInvoiceUnitCommand extends GetInvoiceUnitCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListInvoiceUnitsCommand.d.ts

@@ -98,6 +98,144 @@ declare const ListInvoiceUnitsCommand_base: {
  * <p>Base exception class for all service exceptions from Invoicing service.</p>
  *
  * @public
+ * @example ListInvoiceUnits without filters as of current time
+ * ```javascript
+ * //
+ * const input = {};
+ * const command = new ListInvoiceUnitsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InvoiceUnits": [
+ *     {
+ *       "Description": "Description changed on 1733788800",
+ *       "InvoiceReceiver": "111111111111",
+ *       "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678",
+ *       "LastModified": 1733788800,
+ *       "Name": "Example Invoice Unit A",
+ *       "Rule": {
+ *         "LinkedAccounts": [
+ *           "222222222222"
+ *         ]
+ *       },
+ *       "TaxInheritanceDisabled": false
+ *     },
+ *     {
+ *       "Description": "Description changed on 1733788800",
+ *       "InvoiceReceiver": "333333333333",
+ *       "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321",
+ *       "LastModified": 1733788800,
+ *       "Name": "Example Invoice Unit B",
+ *       "Rule": {
+ *         "LinkedAccounts": [
+ *           "333333333333"
+ *         ]
+ *       },
+ *       "TaxInheritanceDisabled": true
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example ListInvoiceUnits with filters as of specified time
+ * ```javascript
+ * //
+ * const input = {
+ *   "AsOf": 1733097600,
+ *   "Filters": {
+ *     "InvoiceReceivers": [
+ *       "333333333333"
+ *     ]
+ *   }
+ * };
+ * const command = new ListInvoiceUnitsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InvoiceUnits": [
+ *     {
+ *       "Description": "Description changed on 1733011200",
+ *       "InvoiceReceiver": "333333333333",
+ *       "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321",
+ *       "LastModified": 1733011200,
+ *       "Name": "Example Invoice Unit B",
+ *       "Rule": {
+ *         "LinkedAccounts": [
+ *           "333333333333"
+ *         ]
+ *       },
+ *       "TaxInheritanceDisabled": false
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
+ * @example ListInvoiceUnits with pagination - first page
+ * ```javascript
+ * //
+ * const input = {
+ *   "MaxResults": 1
+ * };
+ * const command = new ListInvoiceUnitsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InvoiceUnits": [
+ *     {
+ *       "Description": "Description changed on 1733788800",
+ *       "InvoiceReceiver": "111111111111",
+ *       "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678",
+ *       "LastModified": 1733788800,
+ *       "Name": "Example Invoice Unit A",
+ *       "Rule": {
+ *         "LinkedAccounts": [
+ *           "222222222222"
+ *         ]
+ *       },
+ *       "TaxInheritanceDisabled": false
+ *     }
+ *   ],
+ *   "NextToken": "nextTokenExample"
+ * }
+ * *\/
+ * // example id: example-3
+ * ```
+ *
+ * @example ListInvoiceUnits with pagination - second page
+ * ```javascript
+ * //
+ * const input = {
+ *   "MaxResults": 1,
+ *   "NextToken": "nextTokenExample"
+ * };
+ * const command = new ListInvoiceUnitsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InvoiceUnits": [
+ *     {
+ *       "Description": "Description changed on 1733788800",
+ *       "InvoiceReceiver": "333333333333",
+ *       "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321",
+ *       "LastModified": 1733788800,
+ *       "Name": "Example Invoice Unit B",
+ *       "Rule": {
+ *         "LinkedAccounts": [
+ *           "333333333333"
+ *         ]
+ *       },
+ *       "TaxInheritanceDisabled": true
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-4
+ * ```
+ *
  */
 export declare class ListInvoiceUnitsCommand extends ListInvoiceUnitsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -80,6 +80,27 @@ declare const ListTagsForResourceCommand_base: {
  * <p>Base exception class for all service exceptions from Invoicing service.</p>
  *
  * @public
+ * @example ListTagsForResource
+ * ```javascript
+ * //
+ * const input = {
+ *   "ResourceArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ResourceTags": [
+ *     {
+ *       "Key": "TagKey",
+ *       "Value": "TagValue"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/TagResourceCommand.d.ts

@@ -83,6 +83,23 @@ declare const TagResourceCommand_base: {
  * <p>Base exception class for all service exceptions from Invoicing service.</p>
  *
  * @public
+ * @example TagResource
+ * ```javascript
+ * //
+ * const input = {
+ *   "ResourceArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678",
+ *   "ResourceTags": [
+ *     {
+ *       "Key": "TagKey",
+ *       "Value": "TagValue"
+ *     }
+ *   ]
+ * };
+ * const command = new TagResourceCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -77,6 +77,20 @@ declare const UntagResourceCommand_base: {
  * <p>Base exception class for all service exceptions from Invoicing service.</p>
  *
  * @public
+ * @example UntagResource
+ * ```javascript
+ * //
+ * const input = {
+ *   "ResourceArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678",
+ *   "ResourceTagKeys": [
+ *     "TagKey"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UpdateInvoiceUnitCommand.d.ts

@@ -81,6 +81,47 @@ declare const UpdateInvoiceUnitCommand_base: {
  * <p>Base exception class for all service exceptions from Invoicing service.</p>
  *
  * @public
+ * @example UpdateInvoiceUnit with all updatable fields
+ * ```javascript
+ * //
+ * const input = {
+ *   "Description": "Updated IU description",
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678",
+ *   "Rule": {
+ *     "LinkedAccounts": [
+ *       "111111111111",
+ *       "222222222222"
+ *     ]
+ *   },
+ *   "TaxInheritanceDisabled": false
+ * };
+ * const command = new UpdateInvoiceUnitCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example UpdateInvoiceUnit with specific fields
+ * ```javascript
+ * //
+ * const input = {
+ *   "Description": "Updated IU description. All other fields remain unchanged",
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678"
+ * };
+ * const command = new UpdateInvoiceUnitCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678"
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
  */
 export declare class UpdateInvoiceUnitCommand extends UpdateInvoiceUnitCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-invoicing",
   "description": "AWS SDK for JavaScript Invoicing Client for Node.js, Browser and React Native",
-  "version": "3.703.0",
+  "version": "3.704.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",