Merge pull request #1 from avadev/release/24.12.10

Release/24.12.10
avadev · Jan 2, 2025 · 828b264 · 828b264
2 parents b320e3d + 8a60a4f
commit 828b264
Show file tree

Hide file tree

Showing 90 changed files with 5,786 additions and 5,926 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -11,8 +11,16 @@ jobs:
   test-package:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - run: npm ci
+      - name: Check out the repository
+        uses: actions/checkout@v3
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci --loglevel=silly
 
       # Step to retrieve the bearer token
       - name: Retrieve bearer token
@@ -24,8 +32,11 @@ jobs:
           token=$(echo $response | jq -r '.access_token')
           echo "BEARER_TOKEN=${token}" >> $GITHUB_ENV
 
+      - name: Build
+        run: npm run build
+
       # Use the bearer token as an environment variable in the npm test command
       - name: Run npm test with bearer token
-        run: npm run test
+        run: npm test
         env:
           BEARER_TOKEN: ${{ env.BEARER_TOKEN }}
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1,2 @@
+registry=https://registry.npmjs.org/
+always-auth=false
diff --git a/README.md b/README.md
@@ -142,12 +142,20 @@ const result = await api.ping();
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*DataInputFieldsApi* | [**getDataInputFields**](docs/EInvoicing/V1/DataInputFieldsApi.md#getdatainputfields) | **GET** /data-input-fields | Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
+*DataInputFieldsApi* | [**getDataInputFields**](docs/EInvoicing/V1/DataInputFieldsApi.md#getdatainputfields) | **GET** /data-input-fields | Returns the optionality of document fields for different country mandates
 *DocumentsApi* | [**downloadDocument**](docs/EInvoicing/V1/DocumentsApi.md#downloaddocument) | **GET** /documents/{documentId}/$download | Returns a copy of the document
+*DocumentsApi* | [**fetchDocuments**](docs/EInvoicing/V1/DocumentsApi.md#fetchdocuments) | **POST** /documents/$fetch | Fetch the inbound document from a tax authority
 *DocumentsApi* | [**getDocumentList**](docs/EInvoicing/V1/DocumentsApi.md#getdocumentlist) | **GET** /documents | Returns a summary of documents for a date range
-*DocumentsApi* | [**getDocumentStatus**](docs/EInvoicing/V1/DocumentsApi.md#getdocumentstatus) | **GET** /document/{documentId}/status | Checks the status of a document
+*DocumentsApi* | [**getDocumentStatus**](docs/EInvoicing/V1/DocumentsApi.md#getdocumentstatus) | **GET** /documents/{documentId}/status | Checks the status of a document
 *DocumentsApi* | [**submitDocument**](docs/EInvoicing/V1/DocumentsApi.md#submitdocument) | **POST** /documents | Submits a document to Avalara E-Invoicing API
+*InteropApi* | [**submitInteropDocument**](docs/EInvoicing/V1/InteropApi.md#submitinteropdocument) | **POST** /interop/documents | Submit a document
+*MandatesApi* | [**getMandateDataInputFields**](docs/EInvoicing/V1/MandatesApi.md#getmandatedatainputfields) | **GET** /mandates/{mandateId}/data-input-fields | Returns document field information for a country mandate, a selected document type, and its version
 *MandatesApi* | [**getMandates**](docs/EInvoicing/V1/MandatesApi.md#getmandates) | **GET** /mandates | List country mandates that are supported by the Avalara E-Invoicing platform
+*TradingPartnersApi* | [**batchSearchParticipants**](docs/EInvoicing/V1/TradingPartnersApi.md#batchsearchparticipants) | **POST** /trading-partners/batch-searches | Creates a batch search and performs a batch search in the directory for participants in the background.
+*TradingPartnersApi* | [**downloadBatchSearchReport**](docs/EInvoicing/V1/TradingPartnersApi.md#downloadbatchsearchreport) | **GET** /trading-partners/batch-searches/{id}/$download-results | Download batch search results in a csv file.
+*TradingPartnersApi* | [**getBatchSearchDetail**](docs/EInvoicing/V1/TradingPartnersApi.md#getbatchsearchdetail) | **GET** /trading-partners/batch-searches/{id} | Get the batch search details for a given id.
+*TradingPartnersApi* | [**listBatchSearches**](docs/EInvoicing/V1/TradingPartnersApi.md#listbatchsearches) | **GET** /trading-partners/batch-searches | List all batch searches that were previously submitted.
+*TradingPartnersApi* | [**searchParticipants**](docs/EInvoicing/V1/TradingPartnersApi.md#searchparticipants) | **GET** /trading-partners | Returns a list of participants matching the input query.
 
 <a name="documentation-for-models"></a>
 ## Documentation for Models
@@ -157,26 +165,40 @@ Class | Method | HTTP request | Description
 
  - [EInvoicing.V1.BadDownloadRequest](docs/EInvoicing/V1/BadDownloadRequest.md)
  - [EInvoicing.V1.BadRequest](docs/EInvoicing/V1/BadRequest.md)
+ - [EInvoicing.V1.BatchSearch](docs/EInvoicing/V1/BatchSearch.md)
+ - [EInvoicing.V1.BatchSearchListResponse](docs/EInvoicing/V1/BatchSearchListResponse.md)
  - [EInvoicing.V1.ConditionalForField](docs/EInvoicing/V1/ConditionalForField.md)
  - [EInvoicing.V1.DataInputField](docs/EInvoicing/V1/DataInputField.md)
  - [EInvoicing.V1.DataInputFieldNotUsedFor](docs/EInvoicing/V1/DataInputFieldNotUsedFor.md)
  - [EInvoicing.V1.DataInputFieldOptionalFor](docs/EInvoicing/V1/DataInputFieldOptionalFor.md)
  - [EInvoicing.V1.DataInputFieldRequiredFor](docs/EInvoicing/V1/DataInputFieldRequiredFor.md)
  - [EInvoicing.V1.DataInputFieldsResponse](docs/EInvoicing/V1/DataInputFieldsResponse.md)
+ - [EInvoicing.V1.DirectorySearchResponse](docs/EInvoicing/V1/DirectorySearchResponse.md)
+ - [EInvoicing.V1.DirectorySearchResponseValueInner](docs/EInvoicing/V1/DirectorySearchResponseValueInner.md)
+ - [EInvoicing.V1.DirectorySearchResponseValueInnerAddressesInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerAddressesInner.md)
+ - [EInvoicing.V1.DirectorySearchResponseValueInnerIdentifiersInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerIdentifiersInner.md)
+ - [EInvoicing.V1.DirectorySearchResponseValueInnerSupportedDocumentTypesInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md)
+ - [EInvoicing.V1.DocumentFetch](docs/EInvoicing/V1/DocumentFetch.md)
+ - [EInvoicing.V1.DocumentFetchRequest](docs/EInvoicing/V1/DocumentFetchRequest.md)
+ - [EInvoicing.V1.DocumentFetchRequestDataInner](docs/EInvoicing/V1/DocumentFetchRequestDataInner.md)
+ - [EInvoicing.V1.DocumentFetchRequestMetadata](docs/EInvoicing/V1/DocumentFetchRequestMetadata.md)
  - [EInvoicing.V1.DocumentListResponse](docs/EInvoicing/V1/DocumentListResponse.md)
  - [EInvoicing.V1.DocumentStatusResponse](docs/EInvoicing/V1/DocumentStatusResponse.md)
  - [EInvoicing.V1.DocumentSubmissionError](docs/EInvoicing/V1/DocumentSubmissionError.md)
  - [EInvoicing.V1.DocumentSubmitResponse](docs/EInvoicing/V1/DocumentSubmitResponse.md)
  - [EInvoicing.V1.DocumentSummary](docs/EInvoicing/V1/DocumentSummary.md)
+ - [EInvoicing.V1.ErrorResponse](docs/EInvoicing/V1/ErrorResponse.md)
  - [EInvoicing.V1.ForbiddenError](docs/EInvoicing/V1/ForbiddenError.md)
  - [EInvoicing.V1.InputDataFormats](docs/EInvoicing/V1/InputDataFormats.md)
  - [EInvoicing.V1.InternalServerError](docs/EInvoicing/V1/InternalServerError.md)
  - [EInvoicing.V1.Mandate](docs/EInvoicing/V1/Mandate.md)
+ - [EInvoicing.V1.MandateDataInputField](docs/EInvoicing/V1/MandateDataInputField.md)
+ - [EInvoicing.V1.MandateDataInputFieldNamespace](docs/EInvoicing/V1/MandateDataInputFieldNamespace.md)
  - [EInvoicing.V1.MandatesResponse](docs/EInvoicing/V1/MandatesResponse.md)
  - [EInvoicing.V1.NotFoundError](docs/EInvoicing/V1/NotFoundError.md)
  - [EInvoicing.V1.NotUsedForField](docs/EInvoicing/V1/NotUsedForField.md)
  - [EInvoicing.V1.RequiredWhenField](docs/EInvoicing/V1/RequiredWhenField.md)
  - [EInvoicing.V1.StatusEvent](docs/EInvoicing/V1/StatusEvent.md)
- - [EInvoicing.V1.SubmitDocumentData](docs/EInvoicing/V1/SubmitDocumentData.md)
  - [EInvoicing.V1.SubmitDocumentMetadata](docs/EInvoicing/V1/SubmitDocumentMetadata.md)
+ - [EInvoicing.V1.SubmitInteropDocument202Response](docs/EInvoicing/V1/SubmitInteropDocument202Response.md)
  - [EInvoicing.V1.WorkflowIds](docs/EInvoicing/V1/WorkflowIds.md)
diff --git a/docs/EInvoicing/V1/BatchSearch.md b/docs/EInvoicing/V1/BatchSearch.md
@@ -0,0 +1,16 @@
+# AvalaraSdk.EInvoicing.V1.BatchSearch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | ID of the batch search | [optional] [default to undefined]
+**name** | **string** | Name of the batch report | [optional] [default to undefined]
+**createdBy** | **string** | Email of the user who created the batch search | [optional] [default to undefined]
+**created** | **Date** | Timestamp when the batch search was created | [optional] [default to undefined]
+**lastModified** | **Date** | Timestamp when the batch search was created | [optional] [default to undefined]
+**status** | **string** | Status of the batch search | [optional] [default to undefined]
+**error** | [**ErrorResponse**](ErrorResponse.md) |  | [optional] [default to undefined]
+
+[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)
+
diff --git a/docs/EInvoicing/V1/BatchSearchListResponse.md b/docs/EInvoicing/V1/BatchSearchListResponse.md
@@ -0,0 +1,13 @@
+# AvalaraSdk.EInvoicing.V1.BatchSearchListResponse
+Schema for batch search list
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recordSetCount** | **number** | The count of records in the result set | [optional] [default to undefined]
+**nextLink** | **string** | Next Link | [optional] [default to undefined]
+**value** | [**Array&lt;BatchSearch&gt;**](BatchSearch.md) |  | [optional] [default to undefined]
+
+[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)
+
diff --git a/docs/EInvoicing/V1/DataInputField.md b/docs/EInvoicing/V1/DataInputField.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **fieldId** | **string** | Field ID | [optional] [default to undefined]
 **applicableDocumentRoots** | **Array&lt;object&gt;** |  | [optional] [default to undefined]
 **path** | **string** | Path to this field | [optional] [default to undefined]
-**nameSpace** | **string** | Namespace of this field | [optional] [default to undefined]
+**namespace** | **string** | Namespace of this field | [optional] [default to undefined]
 **fieldName** | **string** | Field name | [optional] [default to undefined]
 **exampleOrFixedValue** | **string** | An example of the content for this field | [optional] [default to undefined]
 **acceptedValues** | **object** | An object representing the acceptable values for this field | [optional] [default to undefined]

diff --git a/docs/EInvoicing/V1/DataInputFieldsApi.md b/docs/EInvoicing/V1/DataInputFieldsApi.md
@@ -4,14 +4,14 @@ All URIs are relative to *https://api.sbx.avalara.com/einvoicing*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**getDataInputFields**](DataInputFieldsApi.md#getdatainputfields) | **GET** /data-input-fields | Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
+[**getDataInputFields**](DataInputFieldsApi.md#getdatainputfields) | **GET** /data-input-fields | Returns the optionality of document fields for different country mandates
 
 
 <a name="getdatainputfields"></a>
 # **getDataInputFields**
 > DataInputFieldsResponse getDataInputFields (string avalaraVersion, string xAvalaraClient, string $filter, number $top, number $skip, boolean $count, boolean $countOnly)
 
-Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
+Returns the optionality of document fields for different country mandates
 
 This endpoint provides a list of required, conditional, and optional fields for each country mandate. You can use the <code>mandates</code> endpoint to retrieve all available country mandates. You can use the $filter query parameter to retrieve fields for a particular mandate
 
@@ -39,7 +39,7 @@ const result = await api.createUser();
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **avalaraVersion** | **string**| The HTTP Header meant to specify the version of the API intended to be used | [default to undefined]
- **xAvalaraClient** | **string**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \&quot;Fingerprint\&quot; | [optional] [default to undefined]
+ **xAvalaraClient** | **string**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] [default to undefined]
  **$filter** | **string**| Filter by field name and value. This filter only supports &lt;code&gt;eq&lt;/code&gt; and &lt;code&gt;contains&lt;/code&gt;. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. | [optional] [default to undefined]
  **$top** | **number**| If nonzero, return no more than this number of results. Used with &lt;code&gt;$skip&lt;/code&gt; to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. | [optional] [default to undefined]
  **$skip** | **number**| If nonzero, skip this number of results before returning data. Used with &lt;code&gt;$top&lt;/code&gt; to provide pagination for large datasets. | [optional] [default to undefined]

diff --git a/docs/EInvoicing/V1/DataInputFieldsResponse.md b/docs/EInvoicing/V1/DataInputFieldsResponse.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**recordSetCount** | **number** | Total count of results | [optional] [default to undefined]
+**recordsetCount** | **number** | Total count of results | [optional] [default to undefined]
 **nextLink** | **string** |  | [optional] [default to undefined]
 **value** | [**Array&lt;DataInputField&gt;**](DataInputField.md) | Array of Data Input Fields | [optional] [default to undefined]
 

diff --git a/docs/EInvoicing/V1/DirectorySearchResponse.md b/docs/EInvoicing/V1/DirectorySearchResponse.md
@@ -0,0 +1,13 @@
+# AvalaraSdk.EInvoicing.V1.DirectorySearchResponse
+Response schema for directory search results
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recordSetCount** | **number** | The count of records in the result set | [optional] [default to undefined]
+**nextLink** | **string** | The next page link to get the next set of results. | [optional] [default to undefined]
+**value** | [**Array&lt;DirectorySearchResponseValueInner&gt;**](DirectorySearchResponseValueInner.md) |  | [optional] [default to undefined]
+
+[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)
+
diff --git a/docs/EInvoicing/V1/DirectorySearchResponseValueInner.md b/docs/EInvoicing/V1/DirectorySearchResponseValueInner.md
@@ -0,0 +1,16 @@
+# AvalaraSdk.EInvoicing.V1.DirectorySearchResponseValueInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Avalara unique ID of the participant in the directory. | [optional] [default to undefined]
+**name** | **string** | Name of the participant (typically, the name of the business entity). | [optional] [default to undefined]
+**network** | **string** | The network where the participant is present. | [optional] [default to undefined]
+**registrationDate** | **Date** | Registration date of the participant if available | [optional] [default to undefined]
+**identifiers** | [**Array&lt;DirectorySearchResponseValueInnerIdentifiersInner&gt;**](DirectorySearchResponseValueInnerIdentifiersInner.md) |  | [optional] [default to undefined]
+**addresses** | [**Array&lt;DirectorySearchResponseValueInnerAddressesInner&gt;**](DirectorySearchResponseValueInnerAddressesInner.md) |  | [optional] [default to undefined]
+**supportedDocumentTypes** | [**Array&lt;DirectorySearchResponseValueInnerSupportedDocumentTypesInner&gt;**](DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md) |  | [optional] [default to undefined]
+
+[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)
+
diff --git a/docs/EInvoicing/V1/DirectorySearchResponseValueInnerAddressesInner.md b/docs/EInvoicing/V1/DirectorySearchResponseValueInnerAddressesInner.md
@@ -0,0 +1,14 @@
+# AvalaraSdk.EInvoicing.V1.DirectorySearchResponseValueInnerAddressesInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line1** | **string** | Address line 1 | [optional] [default to undefined]
+**line2** | **string** | Address line 2 | [optional] [default to undefined]
+**city** | **string** | City | [optional] [default to undefined]
+**state** | **string** | State | [optional] [default to undefined]
+**country** | **string** | Country | [optional] [default to undefined]
+
+[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)
+
diff --git a/docs/EInvoicing/V1/DirectorySearchResponseValueInnerIdentifiersInner.md b/docs/EInvoicing/V1/DirectorySearchResponseValueInnerIdentifiersInner.md
@@ -0,0 +1,11 @@
+# AvalaraSdk.EInvoicing.V1.DirectorySearchResponseValueInnerIdentifiersInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Peppol Participant ID if the participant is in Peppol network | [optional] [default to undefined]
+**value** | **string** | Value of the identifier | [optional] [default to undefined]
+
+[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)
+
diff --git a/docs/EInvoicing/V1/DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md b/docs/EInvoicing/V1/DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md
@@ -0,0 +1,13 @@
+# AvalaraSdk.EInvoicing.V1.DirectorySearchResponseValueInnerSupportedDocumentTypesInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Document type name. | [optional] [default to undefined]
+**value** | **string** | Document type identifier. | [optional] [default to undefined]
+**supportedByTradingPartner** | **boolean** | Does trading partner support receiving this document type | [optional] [default to undefined]
+**supportedByAvalara** | **boolean** | Does avalara support exchanging this document type | [optional] [default to undefined]
+
+[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)
+
diff --git a/docs/EInvoicing/V1/DocumentFetch.md b/docs/EInvoicing/V1/DocumentFetch.md
@@ -0,0 +1,12 @@
+# AvalaraSdk.EInvoicing.V1.DocumentFetch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique ID for this document that can be used for status checking and file downloads. This is a UID created by the Avalara E-Invoicing platform. | [optional] [default to undefined]
+**status** | **string** | Status of the document | [optional] [default to undefined]
+**eventDateTime** | **string** | The date and time when the inbound document was accepted by the Avalara E-Invoicing Platform | [optional] [default to undefined]
+
+[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)
+
diff --git a/docs/EInvoicing/V1/DocumentFetchRequest.md b/docs/EInvoicing/V1/DocumentFetchRequest.md
@@ -0,0 +1,11 @@
+# AvalaraSdk.EInvoicing.V1.DocumentFetchRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array&lt;DocumentFetchRequestDataInner&gt;**](DocumentFetchRequestDataInner.md) | Array of key-value pairs used to retrieve inbound documents from the Tax Authority | [optional] [default to undefined]
+**metadata** | [**DocumentFetchRequestMetadata**](DocumentFetchRequestMetadata.md) |  | [optional] [default to undefined]
+
+[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		registry=https://registry.npmjs.org/
		always-auth=false