Merge pull request #1 from avadev/release/24.12.10

Release/24.12.10
avadev · Jan 3, 2025 · e6ce547 · e6ce547
2 parents 8f2cd26 + 91f18c8
commit e6ce547
Show file tree

Hide file tree

Showing 88 changed files with 7,848 additions and 214 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest]
         ruby: ["2.7"]
     runs-on: ${{ matrix.os }}
     permissions:

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avalara_sdk (0.0.1)
+    avalara_sdk (24.12.10)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM
@@ -15,7 +15,7 @@ GEM
     debase-ruby_core_source (0.10.16)
     diff-lcs (1.5.0)
     dotenv (2.7.6)
-    faraday (1.10.3)
+    faraday (1.10.4)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -31,16 +31,16 @@ GEM
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.1)
+    faraday-multipart (1.1.0)
+      multipart-post (~> 2.0)
+    faraday-net_http (1.0.2)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
     jaro_winkler (1.5.4)
     method_source (1.0.0)
-    multipart-post (2.4.0)
+    multipart-post (2.4.1)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -83,6 +83,7 @@ GEM
     unicode-display_width (1.5.0)
 
 PLATFORMS
+  arm64-darwin-22
   x64-mingw32
   x86_64-darwin-20
   x86_64-linux

diff --git a/README.md b/README.md
@@ -150,12 +150,20 @@ end
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*DataInputFieldsApi* | [**get_data_input_fields**](docs/EInvoicing/V1/DataInputFieldsApi.md#get_data_input_fields) | **GET** /data-input-fields | Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
+*DataInputFieldsApi* | [**get_data_input_fields**](docs/EInvoicing/V1/DataInputFieldsApi.md#get_data_input_fields) | **GET** /data-input-fields | Returns the optionality of document fields for different country mandates
 *DocumentsApi* | [**download_document**](docs/EInvoicing/V1/DocumentsApi.md#download_document) | **GET** /documents/{documentId}/$download | Returns a copy of the document
+*DocumentsApi* | [**fetch_documents**](docs/EInvoicing/V1/DocumentsApi.md#fetch_documents) | **POST** /documents/$fetch | Fetch the inbound document from a tax authority
 *DocumentsApi* | [**get_document_list**](docs/EInvoicing/V1/DocumentsApi.md#get_document_list) | **GET** /documents | Returns a summary of documents for a date range
-*DocumentsApi* | [**get_document_status**](docs/EInvoicing/V1/DocumentsApi.md#get_document_status) | **GET** /document/{documentId}/status | Checks the status of a document
+*DocumentsApi* | [**get_document_status**](docs/EInvoicing/V1/DocumentsApi.md#get_document_status) | **GET** /documents/{documentId}/status | Checks the status of a document
 *DocumentsApi* | [**submit_document**](docs/EInvoicing/V1/DocumentsApi.md#submit_document) | **POST** /documents | Submits a document to Avalara E-Invoicing API
+*InteropApi* | [**submit_interop_document**](docs/EInvoicing/V1/InteropApi.md#submit_interop_document) | **POST** /interop/documents | Submit a document
+*MandatesApi* | [**get_mandate_data_input_fields**](docs/EInvoicing/V1/MandatesApi.md#get_mandate_data_input_fields) | **GET** /mandates/{mandateId}/data-input-fields | Returns document field information for a country mandate, a selected document type, and its version
 *MandatesApi* | [**get_mandates**](docs/EInvoicing/V1/MandatesApi.md#get_mandates) | **GET** /mandates | List country mandates that are supported by the Avalara E-Invoicing platform
+*TradingPartnersApi* | [**batch_search_participants**](docs/EInvoicing/V1/TradingPartnersApi.md#batch_search_participants) | **POST** /trading-partners/batch-searches | Creates a batch search and performs a batch search in the directory for participants in the background.
+*TradingPartnersApi* | [**download_batch_search_report**](docs/EInvoicing/V1/TradingPartnersApi.md#download_batch_search_report) | **GET** /trading-partners/batch-searches/{id}/$download-results | Download batch search results in a csv file.
+*TradingPartnersApi* | [**get_batch_search_detail**](docs/EInvoicing/V1/TradingPartnersApi.md#get_batch_search_detail) | **GET** /trading-partners/batch-searches/{id} | Get the batch search details for a given id.
+*TradingPartnersApi* | [**list_batch_searches**](docs/EInvoicing/V1/TradingPartnersApi.md#list_batch_searches) | **GET** /trading-partners/batch-searches | List all batch searches that were previously submitted.
+*TradingPartnersApi* | [**search_participants**](docs/EInvoicing/V1/TradingPartnersApi.md#search_participants) | **GET** /trading-partners | Returns a list of participants matching the input query.
 
 <a name="documentation-for-models"></a>
 ## Documentation for Models
@@ -165,26 +173,40 @@ Class | Method | HTTP request | Description
 
  - [models.BadDownloadRequest](docs/EInvoicing/V1/BadDownloadRequest.md)
  - [models.BadRequest](docs/EInvoicing/V1/BadRequest.md)
+ - [models.BatchSearch](docs/EInvoicing/V1/BatchSearch.md)
+ - [models.BatchSearchListResponse](docs/EInvoicing/V1/BatchSearchListResponse.md)
  - [models.ConditionalForField](docs/EInvoicing/V1/ConditionalForField.md)
  - [models.DataInputField](docs/EInvoicing/V1/DataInputField.md)
  - [models.DataInputFieldNotUsedFor](docs/EInvoicing/V1/DataInputFieldNotUsedFor.md)
  - [models.DataInputFieldOptionalFor](docs/EInvoicing/V1/DataInputFieldOptionalFor.md)
  - [models.DataInputFieldRequiredFor](docs/EInvoicing/V1/DataInputFieldRequiredFor.md)
  - [models.DataInputFieldsResponse](docs/EInvoicing/V1/DataInputFieldsResponse.md)
+ - [models.DirectorySearchResponse](docs/EInvoicing/V1/DirectorySearchResponse.md)
+ - [models.DirectorySearchResponseValueInner](docs/EInvoicing/V1/DirectorySearchResponseValueInner.md)
+ - [models.DirectorySearchResponseValueInnerAddressesInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerAddressesInner.md)
+ - [models.DirectorySearchResponseValueInnerIdentifiersInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerIdentifiersInner.md)
+ - [models.DirectorySearchResponseValueInnerSupportedDocumentTypesInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md)
+ - [models.DocumentFetch](docs/EInvoicing/V1/DocumentFetch.md)
+ - [models.DocumentFetchRequest](docs/EInvoicing/V1/DocumentFetchRequest.md)
+ - [models.DocumentFetchRequestDataInner](docs/EInvoicing/V1/DocumentFetchRequestDataInner.md)
+ - [models.DocumentFetchRequestMetadata](docs/EInvoicing/V1/DocumentFetchRequestMetadata.md)
  - [models.DocumentListResponse](docs/EInvoicing/V1/DocumentListResponse.md)
  - [models.DocumentStatusResponse](docs/EInvoicing/V1/DocumentStatusResponse.md)
  - [models.DocumentSubmissionError](docs/EInvoicing/V1/DocumentSubmissionError.md)
  - [models.DocumentSubmitResponse](docs/EInvoicing/V1/DocumentSubmitResponse.md)
  - [models.DocumentSummary](docs/EInvoicing/V1/DocumentSummary.md)
+ - [models.ErrorResponse](docs/EInvoicing/V1/ErrorResponse.md)
  - [models.ForbiddenError](docs/EInvoicing/V1/ForbiddenError.md)
  - [models.InputDataFormats](docs/EInvoicing/V1/InputDataFormats.md)
  - [models.InternalServerError](docs/EInvoicing/V1/InternalServerError.md)
  - [models.Mandate](docs/EInvoicing/V1/Mandate.md)
+ - [models.MandateDataInputField](docs/EInvoicing/V1/MandateDataInputField.md)
+ - [models.MandateDataInputFieldNamespace](docs/EInvoicing/V1/MandateDataInputFieldNamespace.md)
  - [models.MandatesResponse](docs/EInvoicing/V1/MandatesResponse.md)
  - [models.NotFoundError](docs/EInvoicing/V1/NotFoundError.md)
  - [models.NotUsedForField](docs/EInvoicing/V1/NotUsedForField.md)
  - [models.RequiredWhenField](docs/EInvoicing/V1/RequiredWhenField.md)
  - [models.StatusEvent](docs/EInvoicing/V1/StatusEvent.md)
- - [models.SubmitDocumentData](docs/EInvoicing/V1/SubmitDocumentData.md)
  - [models.SubmitDocumentMetadata](docs/EInvoicing/V1/SubmitDocumentMetadata.md)
+ - [models.SubmitInteropDocument202Response](docs/EInvoicing/V1/SubmitInteropDocument202Response.md)
  - [models.WorkflowIds](docs/EInvoicing/V1/WorkflowIds.md)
diff --git a/docs/EInvoicing/V1/BadRequest.md b/docs/EInvoicing/V1/BadRequest.md
@@ -14,7 +14,7 @@ require 'avalara_sdk'
 
 instance = AvalaraSdk::EInvoicing::V1::BadRequest.new(
   error: 400,
-  message: Invalid data format YYYY-MM-DDThh:mm:ss expected
+  message: string
 )
 ```
 
diff --git a/docs/EInvoicing/V1/BatchSearch.md b/docs/EInvoicing/V1/BatchSearch.md
@@ -0,0 +1,30 @@
+# AvalaraSdk::EInvoicing::V1::BatchSearch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the batch search | [optional] |
+| **name** | **String** | Name of the batch report | [optional] |
+| **created_by** | **String** | Email of the user who created the batch search | [optional] |
+| **created** | **Time** | Timestamp when the batch search was created | [optional] |
+| **last_modified** | **Time** | Timestamp when the batch search was created | [optional] |
+| **status** | **String** | Status of the batch search | [optional] |
+| **error** | [**ErrorResponse**](ErrorResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::BatchSearch.new(
+  id: 2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99,
+  name: Batch Search Report 1,
+  created_by: user@example.com,
+  created: 2024-08-01T12:34:56Z,
+  last_modified: 2024-08-01T12:34:56Z,
+  status: Accepted,
+  error: null
+)
+```
+
diff --git a/docs/EInvoicing/V1/BatchSearchListResponse.md b/docs/EInvoicing/V1/BatchSearchListResponse.md
@@ -0,0 +1,22 @@
+# AvalaraSdk::EInvoicing::V1::BatchSearchListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **record_set_count** | **Integer** | The count of records in the result set | [optional] |
+| **next_link** | **String** | Next Link | [optional] |
+| **value** | [**Array&lt;BatchSearch&gt;**](BatchSearch.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::BatchSearchListResponse.new(
+  record_set_count: 500,
+  next_link: TODO,
+  value: null
+)
+```
+
diff --git a/docs/EInvoicing/V1/DataInputField.md b/docs/EInvoicing/V1/DataInputField.md
@@ -8,7 +8,7 @@
 | **field_id** | **String** | Field ID | [optional] |
 | **applicable_document_roots** | **Array&lt;Object&gt;** |  | [optional] |
 | **path** | **String** | Path to this field | [optional] |
-| **name_space** | **String** | Namespace of this field | [optional] |
+| **namespace** | **String** | Namespace of this field | [optional] |
 | **field_name** | **String** | Field name | [optional] |
 | **example_or_fixed_value** | **String** | An example of the content for this field | [optional] |
 | **accepted_values** | **Object** | An object representing the acceptable values for this field | [optional] |
@@ -30,7 +30,7 @@ instance = AvalaraSdk::EInvoicing::V1::DataInputField.new(
   field_id: 1,
   applicable_document_roots: null,
   path: invoice/cbc:CustomizationID,
-  name_space: cbc:,
+  namespace: cbc:,
   field_name: cbc:CustomizationID,
   example_or_fixed_value: urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0,
   accepted_values: null,

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 |
 | ------ | ------------ | ----------- |
-| [**get_data_input_fields**](DataInputFieldsApi.md#get_data_input_fields) | **GET** /data-input-fields | Returns the mandatory and conditional invoice or creditnote input fields for different country mandates |
+| [**get_data_input_fields**](DataInputFieldsApi.md#get_data_input_fields) | **GET** /data-input-fields | Returns the optionality of document fields for different country mandates |
 
 
 ## get_data_input_fields
 
 > <DataInputFieldsResponse> get_data_input_fields(avalara_version, opts)
 
-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
 
@@ -33,9 +33,9 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::EInvoicing::V1::DataInputFieldsApi.new api_client
 
-avalara_version = '1.0' # String | The HTTP Header meant to specify the version of the API intended to be used
+avalara_version = '1.2' # String | The HTTP Header meant to specify the version of the API intended to be used
 opts = {
-  x_avalara_client: 'John's E-Invoicing-API Client', # 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\"
+  x_avalara_client: 'John's E-Invoicing-API Client', # 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.
   filter: 'requiredFor/countryMandate eq AU-B2G-PEPPOL', # String | Filter by field name and value. This filter only supports <code>eq</code> and <code>contains</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering.
   top: 10, # Float | If nonzero, return no more than this number of results. Used with <code>$skip</code> 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.
   skip: 10, # Float | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.
@@ -44,7 +44,7 @@ opts = {
 }
 
 begin
-  # Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
+  # Returns the optionality of document fields for different country mandates
   result = api_instance.get_data_input_fields(avalara_version, opts)
   p result
 rescue AvalaraSdk::ApiError => e
@@ -60,7 +60,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
+  # Returns the optionality of document fields for different country mandates
   data, status_code, headers = api_instance.get_data_input_fields_with_http_info(avalara_version, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -75,7 +75,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used |  |
-| **x_avalara_client** | **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] |
+| **x_avalara_client** | **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] |
 | **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] |
 | **top** | **Float** | 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] |
 | **skip** | **Float** | 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] |

diff --git a/docs/EInvoicing/V1/DataInputFieldsResponse.md b/docs/EInvoicing/V1/DataInputFieldsResponse.md
@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **record_set_count** | **Float** | Total count of results | [optional] |
+| **recordset_count** | **Float** | Total count of results | [optional] |
 | **next_link** | **String** |  | [optional] |
 | **value** | [**Array&lt;DataInputField&gt;**](DataInputField.md) | Array of Data Input Fields | [optional] |
 
@@ -14,7 +14,7 @@
 require 'avalara_sdk'
 
 instance = AvalaraSdk::EInvoicing::V1::DataInputFieldsResponse.new(
-  record_set_count: 1,
+  recordset_count: 1,
   next_link: null,
   value: null
 )

diff --git a/docs/EInvoicing/V1/DirectorySearchResponse.md b/docs/EInvoicing/V1/DirectorySearchResponse.md
@@ -0,0 +1,22 @@
+# AvalaraSdk::EInvoicing::V1::DirectorySearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **record_set_count** | **Integer** | The count of records in the result set | [optional] |
+| **next_link** | **String** | The next page link to get the next set of results. | [optional] |
+| **value** | [**Array&lt;DirectorySearchResponseValueInner&gt;**](DirectorySearchResponseValueInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::DirectorySearchResponse.new(
+  record_set_count: 500,
+  next_link: TODO,
+  value: null
+)
+```
+
diff --git a/docs/EInvoicing/V1/DirectorySearchResponseValueInner.md b/docs/EInvoicing/V1/DirectorySearchResponseValueInner.md
@@ -0,0 +1,30 @@
+# AvalaraSdk::EInvoicing::V1::DirectorySearchResponseValueInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Avalara unique ID of the participant in the directory. | [optional] |
+| **name** | **String** | Name of the participant (typically, the name of the business entity). | [optional] |
+| **network** | **String** | The network where the participant is present. | [optional] |
+| **registration_date** | **Date** | Registration date of the participant if available | [optional] |
+| **identifiers** | [**Array&lt;DirectorySearchResponseValueInnerIdentifiersInner&gt;**](DirectorySearchResponseValueInnerIdentifiersInner.md) |  | [optional] |
+| **addresses** | [**Array&lt;DirectorySearchResponseValueInnerAddressesInner&gt;**](DirectorySearchResponseValueInnerAddressesInner.md) |  | [optional] |
+| **supported_document_types** | [**Array&lt;DirectorySearchResponseValueInnerSupportedDocumentTypesInner&gt;**](DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::DirectorySearchResponseValueInner.new(
+  id: 2a27ee0cf5bcb6165ab891503652343419a8fc5fe6b406299c47d7b44aa8548c,
+  name: Pineapple Labs ltd,
+  network: Peppol,
+  registration_date: null,
+  identifiers: null,
+  addresses: null,
+  supported_document_types: null
+)
+```
+
diff --git a/docs/EInvoicing/V1/DirectorySearchResponseValueInnerAddressesInner.md b/docs/EInvoicing/V1/DirectorySearchResponseValueInnerAddressesInner.md
@@ -0,0 +1,26 @@
+# AvalaraSdk::EInvoicing::V1::DirectorySearchResponseValueInnerAddressesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line1** | **String** | Address line 1 | [optional] |
+| **line2** | **String** | Address line 2 | [optional] |
+| **city** | **String** | City | [optional] |
+| **state** | **String** | State | [optional] |
+| **country** | **String** | Country | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::DirectorySearchResponseValueInnerAddressesInner.new(
+  line1: ,
+  line2: ,
+  city: ,
+  state: ,
+  country: 
+)
+```
+
diff --git a/docs/EInvoicing/V1/DirectorySearchResponseValueInnerIdentifiersInner.md b/docs/EInvoicing/V1/DirectorySearchResponseValueInnerIdentifiersInner.md
@@ -0,0 +1,20 @@
+# AvalaraSdk::EInvoicing::V1::DirectorySearchResponseValueInnerIdentifiersInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Peppol Participant ID if the participant is in Peppol network | [optional] |
+| **value** | **String** | Value of the identifier | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::DirectorySearchResponseValueInnerIdentifiersInner.new(
+  name: PeppolParticipantId,
+  value: 9930:de112233445
+)
+```
+