avalara_sdk 25.7.0 → 25.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +76 -39
- data/docs/A1099/V2/BulkUpsert1099FormsRequest.md +3 -1
- data/docs/A1099/V2/CompaniesW9Api.md +22 -22
- data/docs/A1099/V2/CoveredIndividualReferenceResponse.md +56 -0
- data/docs/A1099/V2/CoveredIndividualRequest.md +19 -19
- data/docs/A1099/V2/Create1099Form201Response.md +59 -0
- data/docs/A1099/V2/CreateW9Form201Response.md +55 -0
- data/docs/A1099/V2/CreateW9FormRequest.md +55 -0
- data/docs/A1099/V2/Form1042SList.md +20 -0
- data/docs/A1099/V2/Form1042SListItem.md +108 -0
- data/docs/A1099/V2/Form1042SListItemResponse.md +130 -0
- data/docs/A1099/V2/Form1042SRequest.md +110 -0
- data/docs/A1099/V2/Form1042SResponse.md +88 -0
- data/docs/A1099/V2/Form1095BListItem.md +31 -31
- data/docs/A1099/V2/Form1095BListItemResponse.md +86 -0
- data/docs/A1099/V2/Form1095BRequest.md +33 -33
- data/docs/A1099/V2/Form1099BaseResponse.md +82 -0
- data/docs/A1099/V2/Form1099DivListItem.md +45 -45
- data/docs/A1099/V2/Form1099DivRequest.md +44 -44
- data/docs/A1099/V2/Form1099DivResponse.md +3 -3
- data/docs/A1099/V2/Form1099KListItem.md +46 -46
- data/docs/A1099/V2/Form1099KListItemResponse.md +122 -0
- data/docs/A1099/V2/Form1099KRequest.md +45 -45
- data/docs/A1099/V2/Form1099ListResponse.md +18 -0
- data/docs/A1099/V2/Form1099ListResponseValueInner.md +59 -0
- data/docs/A1099/V2/Form1099MiscListItem.md +43 -43
- data/docs/A1099/V2/Form1099MiscListItemResponse.md +108 -0
- data/docs/A1099/V2/Form1099MiscRequest.md +42 -42
- data/docs/A1099/V2/Form1099MiscResponse.md +5 -5
- data/docs/A1099/V2/Form1099NecListItem.md +31 -31
- data/docs/A1099/V2/Form1099NecListItemResponse.md +88 -0
- data/docs/A1099/V2/Form1099NecRequest.md +30 -30
- data/docs/A1099/V2/Form1099NecResponse.md +5 -5
- data/docs/A1099/V2/Form1099RListItem.md +47 -47
- data/docs/A1099/V2/Form1099RListItemResponse.md +122 -0
- data/docs/A1099/V2/Form1099RRequest.md +45 -45
- data/docs/A1099/V2/Form1099StatusDetailResponse.md +20 -0
- data/docs/A1099/V2/FormRequestBase.md +23 -23
- data/docs/A1099/V2/FormRequestListItemBase.md +66 -0
- data/docs/A1099/V2/FormResponseBase.md +3 -3
- data/docs/A1099/V2/FormSingleRequestBase.md +25 -25
- data/docs/A1099/V2/Forms1099Api.md +75 -63
- data/docs/A1099/V2/FormsW9Api.md +61 -56
- data/docs/A1099/V2/Get1099Form200Response.md +15 -11
- data/docs/A1099/V2/IntermediaryOrFlowThrough.md +38 -0
- data/docs/A1099/V2/IntermediaryOrFlowThroughRequest.md +38 -0
- data/docs/A1099/V2/IntermediaryOrFlowThroughResponse.md +38 -0
- data/docs/A1099/V2/Issuers1099Api.md +23 -23
- data/docs/A1099/V2/JobResult.md +15 -15
- data/docs/A1099/V2/Jobs1099Api.md +2 -2
- data/docs/A1099/V2/PrimaryWithholdingAgent.md +20 -0
- data/docs/A1099/V2/PrimaryWithholdingAgentRequest.md +20 -0
- data/docs/A1099/V2/PrimaryWithholdingAgentResponse.md +20 -0
- data/docs/A1099/V2/StateAndLocalWithholdingResponse.md +8 -8
- data/docs/A1099/V2/StateEfileStatusDetailResponse.md +22 -0
- data/docs/A1099/V2/SubstantialUsOwnerRequest.md +22 -0
- data/docs/A1099/V2/Update1099Form200Response.md +3 -1
- data/docs/A1099/V2/ValidationErrorResponse.md +20 -0
- data/docs/A1099/V2/W4FormDataModel.md +5 -5
- data/docs/A1099/V2/W4FormRequest.md +66 -0
- data/docs/A1099/V2/W8BenEFormRequest.md +218 -0
- data/docs/A1099/V2/W8BenEFormResponse.md +3 -3
- data/docs/A1099/V2/W8BenFormDataModel.md +5 -5
- data/docs/A1099/V2/W8BenFormRequest.md +76 -0
- data/docs/A1099/V2/W8BeneFormDataModel.md +5 -5
- data/docs/A1099/V2/W8ImyFormDataModel.md +5 -5
- data/docs/A1099/V2/W8ImyFormRequest.md +250 -0
- data/docs/A1099/V2/W8ImyFormResponse.md +2 -2
- data/docs/A1099/V2/W9FormBaseRequest.md +28 -0
- data/docs/A1099/V2/W9FormDataModel.md +5 -5
- data/docs/A1099/V2/W9FormRequest.md +64 -0
- data/docs/EInvoicing/V1/Address.md +28 -0
- data/docs/EInvoicing/V1/BatchErrorDetail.md +20 -0
- data/docs/EInvoicing/V1/BatchSearchListResponse.md +2 -2
- data/docs/EInvoicing/V1/Consents.md +18 -0
- data/docs/EInvoicing/V1/CreateTradingPartner201Response.md +22 -0
- data/docs/EInvoicing/V1/CreateTradingPartnersBatch200Response.md +22 -0
- data/docs/EInvoicing/V1/CreateTradingPartnersBatch200ResponseValueInner.md +22 -0
- data/docs/EInvoicing/V1/CreateTradingPartnersBatchRequest.md +18 -0
- data/docs/EInvoicing/V1/DataInputFieldsApi.md +5 -5
- data/docs/EInvoicing/V1/DocumentsApi.md +9 -9
- data/docs/EInvoicing/V1/Extension.md +20 -0
- data/docs/EInvoicing/V1/Identifier.md +22 -0
- data/docs/EInvoicing/V1/InteropApi.md +1 -1
- data/docs/EInvoicing/V1/MandatesApi.md +6 -6
- data/docs/EInvoicing/V1/SearchParticipants200Response.md +22 -0
- data/docs/EInvoicing/V1/SubscriptionsApi.md +12 -12
- data/docs/EInvoicing/V1/SupportedDocumentTypes.md +26 -0
- data/docs/EInvoicing/V1/TaxIdentifierRequest.md +24 -0
- data/docs/EInvoicing/V1/TaxIdentifierResponse.md +20 -0
- data/docs/EInvoicing/V1/TaxIdentifierResponseValue.md +22 -0
- data/docs/EInvoicing/V1/TaxIdentifierSchemaByCountry200Response.md +20 -0
- data/docs/EInvoicing/V1/TaxIdentifiersApi.md +177 -0
- data/docs/EInvoicing/V1/TradingPartner.md +34 -0
- data/docs/EInvoicing/V1/TradingPartnersApi.md +412 -75
- data/docs/EInvoicing/V1/UpdateTradingPartner200Response.md +22 -0
- data/docs/EInvoicing/V1/ValidationError.md +20 -0
- data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +14 -14
- data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +51 -39
- data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +56 -50
- data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +20 -20
- data/lib/avalara_sdk/api/A1099/V2/jobs1099_api.rb +2 -2
- data/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +7 -7
- data/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +11 -11
- data/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +2 -2
- data/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +8 -8
- data/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +21 -21
- data/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb +531 -0
- data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +660 -80
- data/lib/avalara_sdk/models/A1099/V2/attribute.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/authorized_api_request_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/authorized_api_request_v2_data_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/base_company_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/base_form_list_request.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/bulk_upsert1099_forms_request.rb +2 -1
- data/lib/avalara_sdk/models/A1099/V2/company_create_update_request_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/company_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/company_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/company_response_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/covered_individual_reference_response.rb +407 -0
- data/lib/avalara_sdk/models/A1099/V2/covered_individual_request.rb +20 -1
- data/lib/avalara_sdk/models/A1099/V2/create1099_form201_response.rb +106 -0
- data/lib/avalara_sdk/models/A1099/V2/create_w9_form201_response.rb +104 -0
- data/lib/avalara_sdk/models/A1099/V2/create_w9_form_request.rb +104 -0
- data/lib/avalara_sdk/models/A1099/V2/data.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/error_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/error_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/error_response_errors_inner.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_list.rb +238 -0
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb +891 -0
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_list_item_response.rb +925 -0
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_request.rb +855 -0
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_response.rb +600 -0
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_list.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_list_item.rb +147 -14
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_list_item_response.rb +700 -0
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_request.rb +149 -16
- data/lib/avalara_sdk/models/A1099/V2/form1099_base_response.rb +661 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_list.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_list_item.rb +168 -13
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_request.rb +159 -14
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_response.rb +5 -5
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_list.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_list_item.rb +169 -13
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_list_item_response.rb +930 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_request.rb +160 -14
- data/lib/avalara_sdk/models/A1099/V2/form1099_list_response.rb +220 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_list_response_value_inner.rb +106 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list_item.rb +171 -19
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list_item_response.rb +810 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_request.rb +162 -20
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_response.rb +12 -12
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list_item.rb +168 -20
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list_item_response.rb +700 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb +157 -20
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_response.rb +12 -12
- data/lib/avalara_sdk/models/A1099/V2/form1099_proccess_result.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_list.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_list_item.rb +171 -15
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_list_item_response.rb +888 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_request.rb +160 -14
- data/lib/avalara_sdk/models/A1099/V2/form1099_status_detail_response.rb +223 -0
- data/lib/avalara_sdk/models/A1099/V2/form_request_base.rb +138 -12
- data/lib/avalara_sdk/models/A1099/V2/form_request_list_item_base.rb +611 -0
- data/lib/avalara_sdk/models/A1099/V2/form_response_base.rb +5 -5
- data/lib/avalara_sdk/models/A1099/V2/form_single_request_base.rb +140 -14
- data/lib/avalara_sdk/models/A1099/V2/get1099_form200_response.rb +8 -6
- data/lib/avalara_sdk/models/A1099/V2/http_validation_problem_details.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/i_create_form1099_request.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/i_update_form1099_request.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb +311 -0
- data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through_request.rb +311 -0
- data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through_response.rb +311 -0
- data/lib/avalara_sdk/models/A1099/V2/issuer_command.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/issuer_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/iw9_form_data_models_one_of.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/job_result.rb +16 -1
- data/lib/avalara_sdk/models/A1099/V2/link.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/paginated_query_result_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/paginated_query_result_model_company_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/paginated_query_result_model_issuer_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/paginated_w9_forms_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent.rb +221 -0
- data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent_request.rb +221 -0
- data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent_response.rb +221 -0
- data/lib/avalara_sdk/models/A1099/V2/problem_details.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_request.rb +5 -1
- data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_response.rb +9 -1
- data/lib/avalara_sdk/models/A1099/V2/state_efile_status_detail_response.rb +231 -0
- data/lib/avalara_sdk/models/A1099/V2/status_detail.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/substantial_us_owner_request.rb +233 -0
- data/lib/avalara_sdk/models/A1099/V2/substantial_us_owner_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/update1099_form200_response.rb +2 -1
- data/lib/avalara_sdk/models/A1099/V2/validation_error_response.rb +231 -0
- data/lib/avalara_sdk/models/A1099/V2/w4_form_data_model.rb +6 -6
- data/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb +509 -0
- data/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +1343 -0
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb +4 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_substantial_us_owner_data_model.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_data_model.rb +6 -6
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +561 -0
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/w8_bene_form_data_model.rb +6 -6
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_data_model.rb +6 -6
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb +1518 -0
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb +3 -3
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb +299 -0
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/w9_form_data_model.rb +6 -6
- data/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb +495 -0
- data/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb +4 -3
- data/lib/avalara_sdk/models/EInvoicing/V1/address.rb +382 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/batch_error_detail.rb +223 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/batch_search.rb +1 -1
- data/lib/avalara_sdk/models/EInvoicing/V1/batch_search_list_response.rb +3 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/consents.rb +213 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/create_trading_partner201_response.rb +231 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/create_trading_partners_batch200_response.rb +232 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.rb +231 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/create_trading_partners_batch_request.rb +212 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/data_input_fields_response.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/document_fetch.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/error_response.rb +1 -1
- data/lib/avalara_sdk/models/EInvoicing/V1/extension.rb +256 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/hmac_signature_value.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/identifier.rb +302 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/mandate.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/pagination.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/required_when_field.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/search_participants200_response.rb +232 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/signature.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/signature_value.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/subscription_common.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/success_response.rb +1 -2
- data/lib/avalara_sdk/models/EInvoicing/V1/supported_document_types.rb +305 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/tax_identifier_request.rb +329 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/tax_identifier_response.rb +228 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/tax_identifier_response_value.rb +231 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.rb +235 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb +411 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/update_trading_partner200_response.rb +231 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/validation_error.rb +222 -0
- data/lib/avalara_sdk/models/EInvoicing/V1/webhooks_error_response.rb +1 -2
- data/lib/avalara_sdk/version.rb +1 -1
- data/lib/avalara_sdk.rb +53 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/date_core.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/mkmf.log +4 -4
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/attach.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/debase_internals.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/gem_make.out +7 -7
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/mkmf.log +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/debug/debug.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/erb/escape.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/io/console.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/mkmf.log +21 -21
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/json/ext/generator.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/json/ext/parser.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/mkmf.log +7 -7
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/mkmf.log +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/prism/prism.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/mkmf.log +10 -10
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/psych.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/racc/cparse.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/ruby-debug-ide-0.7.3/gem_make.out +2 -2
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/mkmf.log +2 -2
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/stringio.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/byebug-11.1.3/ext/byebug/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/date-3.4.1/ext/date/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/date-3.4.1/lib/date_core.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/debase-0.2.9/ext/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/debase-0.2.9/ext/attach/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/debase-0.2.9/lib/attach.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/debase-0.2.9/lib/debase_internals.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/debug-1.10.0/ext/debug/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/debug-1.10.0/lib/debug/debug.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/erb-5.0.1/ext/erb/escape/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/erb-5.0.1/lib/erb/escape.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/io-console-0.8.0/ext/io/console/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/io-console-0.8.0/lib/io/console.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/json-2.12.2/ext/json/ext/generator/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/json-2.12.2/ext/json/ext/parser/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/json-2.12.2/lib/json/ext/generator.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/json-2.12.2/lib/json/ext/parser.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/prism-1.4.0/ext/prism/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/prism-1.4.0/lib/prism/prism.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/lib/psych.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/lib/racc/cparse.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.7/ext/stringio/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.7/lib/stringio.so +0 -0
- metadata +109 -3
@@ -4,21 +4,25 @@ All URIs are relative to *https://api.sbx.avalara.com/einvoicing*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**batch_search_participants**](TradingPartnersApi.md#batch_search_participants) | **POST** /trading-partners/batch-searches |
|
8
|
-
| [**
|
9
|
-
| [**
|
10
|
-
| [**
|
7
|
+
| [**batch_search_participants**](TradingPartnersApi.md#batch_search_participants) | **POST** /trading-partners/batch-searches | Handles batch search requests by uploading a file containing search parameters. |
|
8
|
+
| [**create_trading_partner**](TradingPartnersApi.md#create_trading_partner) | **POST** /trading-partners | Creates a new trading partner. |
|
9
|
+
| [**create_trading_partners_batch**](TradingPartnersApi.md#create_trading_partners_batch) | **POST** /trading-partners/batch | Creates a batch of multiple trading partners. |
|
10
|
+
| [**delete_trading_partner**](TradingPartnersApi.md#delete_trading_partner) | **DELETE** /trading-partners/{id} | Deletes a trading partner using ID. |
|
11
|
+
| [**download_batch_search_report**](TradingPartnersApi.md#download_batch_search_report) | **GET** /trading-partners/batch-searches/{id}/$download-results | Downloads batch search results in a csv file. |
|
12
|
+
| [**get_batch_search_detail**](TradingPartnersApi.md#get_batch_search_detail) | **GET** /trading-partners/batch-searches/{id} | Returns the batch search details using ID. |
|
13
|
+
| [**list_batch_searches**](TradingPartnersApi.md#list_batch_searches) | **GET** /trading-partners/batch-searches | Lists all batch searches that were previously submitted. |
|
11
14
|
| [**search_participants**](TradingPartnersApi.md#search_participants) | **GET** /trading-partners | Returns a list of participants matching the input query. |
|
15
|
+
| [**update_trading_partner**](TradingPartnersApi.md#update_trading_partner) | **PUT** /trading-partners/{id} | Updates a trading partner using ID. |
|
12
16
|
|
13
17
|
|
14
18
|
## batch_search_participants
|
15
19
|
|
16
20
|
> <BatchSearchParticipants202Response> batch_search_participants(avalara_version, name, notification_email, file, opts)
|
17
21
|
|
18
|
-
Creates a batch search and performs a batch search in the directory for participants in the background.
|
19
|
-
|
20
22
|
Handles batch search requests by uploading a file containing search parameters.
|
21
23
|
|
24
|
+
This endpoint creates a batch search and performs a batch search in the directory for participants in the background.
|
25
|
+
|
22
26
|
### Examples
|
23
27
|
|
24
28
|
```ruby
|
@@ -37,17 +41,17 @@ end
|
|
37
41
|
api_client = AvalaraSdk::ApiClient.new config
|
38
42
|
api_instance = AvalaraSdk::EInvoicing::V1::TradingPartnersApi.new api_client
|
39
43
|
|
40
|
-
avalara_version = '1.
|
41
|
-
name = 'Automotive Companies in London Search' # String |
|
42
|
-
notification_email = 'user@example.com' # String | The email address
|
43
|
-
file = File.new('/path/to/some/file') # File | CSV file containing search parameters.
|
44
|
+
avalara_version = '1.4' # String | The HTTP Header meant to specify the version of the API intended to be used.
|
45
|
+
name = 'Automotive Companies in London Search' # String | A <b>human-readable</b> name for the batch search.
|
46
|
+
notification_email = 'user@example.com' # String | The email address to which a notification will be sent once the batch search is complete.
|
47
|
+
file = File.new('/path/to/some/file') # File | CSV file containing search parameters. Input Constraints: - Maximum file size: 1 MB - File Header: Must be less than 500 KB - Total number of lines (including header): Must be 101 or fewer
|
44
48
|
opts = {
|
45
|
-
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\"
|
49
|
+
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\".
|
46
50
|
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
47
51
|
}
|
48
52
|
|
49
53
|
begin
|
50
|
-
#
|
54
|
+
# Handles batch search requests by uploading a file containing search parameters.
|
51
55
|
result = api_instance.batch_search_participants(avalara_version, name, notification_email, file, opts)
|
52
56
|
p result
|
53
57
|
rescue AvalaraSdk::ApiError => e
|
@@ -63,7 +67,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
63
67
|
|
64
68
|
```ruby
|
65
69
|
begin
|
66
|
-
#
|
70
|
+
# Handles batch search requests by uploading a file containing search parameters.
|
67
71
|
data, status_code, headers = api_instance.batch_search_participants_with_http_info(avalara_version, name, notification_email, file, opts)
|
68
72
|
p status_code # => 2xx
|
69
73
|
p headers # => { ... }
|
@@ -77,11 +81,11 @@ end
|
|
77
81
|
|
78
82
|
| Name | Type | Description | Notes |
|
79
83
|
| ---- | ---- | ----------- | ----- |
|
80
|
-
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used | |
|
81
|
-
| **name** | **String** |
|
82
|
-
| **notification_email** | **String** | The email address
|
83
|
-
| **file** | **File** | CSV file containing search parameters. | |
|
84
|
-
| **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\"
|
84
|
+
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used. | |
|
85
|
+
| **name** | **String** | A <b>human-readable</b> name for the batch search. | |
|
86
|
+
| **notification_email** | **String** | The email address to which a notification will be sent once the batch search is complete. | |
|
87
|
+
| **file** | **File** | CSV file containing search parameters. Input Constraints: - Maximum file size: 1 MB - File Header: Must be less than 500 KB - Total number of lines (including header): Must be 101 or fewer | |
|
88
|
+
| **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] |
|
85
89
|
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
86
90
|
|
87
91
|
### Return type
|
@@ -98,13 +102,261 @@ end
|
|
98
102
|
- **Accept**: application/json
|
99
103
|
|
100
104
|
|
105
|
+
## create_trading_partner
|
106
|
+
|
107
|
+
> <CreateTradingPartner201Response> create_trading_partner(avalara_version, trading_partner, opts)
|
108
|
+
|
109
|
+
Creates a new trading partner.
|
110
|
+
|
111
|
+
This endpoint creates a new trading partner with the provided details. The request body must include the necessary information as defined in the `TradingPartner` schema.
|
112
|
+
|
113
|
+
### Examples
|
114
|
+
|
115
|
+
```ruby
|
116
|
+
require 'time'
|
117
|
+
require 'avalara_sdk'
|
118
|
+
# setup authorization
|
119
|
+
AvalaraSdk::EInvoicing::V1.configure do |config|
|
120
|
+
# See Documentation for Authorization section in main README.md for more auth examples.
|
121
|
+
config.bearer_token='<Your Avalara Identity Access Token>'
|
122
|
+
config.environment='sandbox'
|
123
|
+
config.app_name='testApp'
|
124
|
+
config.app_version='1.2.3'
|
125
|
+
config.machine_name='testMachine'
|
126
|
+
end
|
127
|
+
|
128
|
+
api_client = AvalaraSdk::ApiClient.new config
|
129
|
+
api_instance = AvalaraSdk::EInvoicing::V1::TradingPartnersApi.new api_client
|
130
|
+
|
131
|
+
avalara_version = '1.4' # String | The HTTP Header meant to specify the version of the API intended to be used.
|
132
|
+
trading_partner = AvalaraSdk::EInvoicing::V1::TradingPartner.new({name: 'name_example', identifiers: [AvalaraSdk::EInvoicing::V1::Identifier.new({name: 'name_example', value: 'value_example'})], addresses: [AvalaraSdk::EInvoicing::V1::Address.new({country: 'country_example'})], supported_document_types: [AvalaraSdk::EInvoicing::V1::SupportedDocumentTypes.new({value: 'value_example', supported_by_trading_partner: false})]}) # TradingPartner |
|
133
|
+
opts = {
|
134
|
+
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\".
|
135
|
+
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
136
|
+
}
|
137
|
+
|
138
|
+
begin
|
139
|
+
# Creates a new trading partner.
|
140
|
+
result = api_instance.create_trading_partner(avalara_version, trading_partner, opts)
|
141
|
+
p result
|
142
|
+
rescue AvalaraSdk::ApiError => e
|
143
|
+
puts "Error when calling TradingPartnersApi->create_trading_partner: #{e}"
|
144
|
+
end
|
145
|
+
```
|
146
|
+
|
147
|
+
#### Using the create_trading_partner_with_http_info variant
|
148
|
+
|
149
|
+
This returns an Array which contains the response data, status code and headers.
|
150
|
+
|
151
|
+
> <Array(<CreateTradingPartner201Response>, Integer, Hash)> create_trading_partner_with_http_info(avalara_version, trading_partner, opts)
|
152
|
+
|
153
|
+
```ruby
|
154
|
+
begin
|
155
|
+
# Creates a new trading partner.
|
156
|
+
data, status_code, headers = api_instance.create_trading_partner_with_http_info(avalara_version, trading_partner, opts)
|
157
|
+
p status_code # => 2xx
|
158
|
+
p headers # => { ... }
|
159
|
+
p data # => <CreateTradingPartner201Response>
|
160
|
+
rescue AvalaraSdk::EInvoicing::V1::ApiError => e
|
161
|
+
puts "Error when calling TradingPartnersApi->create_trading_partner_with_http_info: #{e}"
|
162
|
+
end
|
163
|
+
```
|
164
|
+
|
165
|
+
### Parameters
|
166
|
+
|
167
|
+
| Name | Type | Description | Notes |
|
168
|
+
| ---- | ---- | ----------- | ----- |
|
169
|
+
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used. | |
|
170
|
+
| **trading_partner** | [**TradingPartner**](TradingPartner.md) | | |
|
171
|
+
| **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] |
|
172
|
+
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
173
|
+
|
174
|
+
### Return type
|
175
|
+
|
176
|
+
[**CreateTradingPartner201Response**](CreateTradingPartner201Response.md)
|
177
|
+
|
178
|
+
### Authorization
|
179
|
+
|
180
|
+
[Bearer](../../../README.md#documentation-for-authorization)
|
181
|
+
|
182
|
+
### HTTP request headers
|
183
|
+
|
184
|
+
- **Content-Type**: application/json
|
185
|
+
- **Accept**: application/json
|
186
|
+
|
187
|
+
|
188
|
+
## create_trading_partners_batch
|
189
|
+
|
190
|
+
> <CreateTradingPartnersBatch200Response> create_trading_partners_batch(avalara_version, create_trading_partners_batch_request, opts)
|
191
|
+
|
192
|
+
Creates a batch of multiple trading partners.
|
193
|
+
|
194
|
+
This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or 1 MB request payload. The batch is processed atomically and partial success is not allowed.
|
195
|
+
|
196
|
+
### Examples
|
197
|
+
|
198
|
+
```ruby
|
199
|
+
require 'time'
|
200
|
+
require 'avalara_sdk'
|
201
|
+
# setup authorization
|
202
|
+
AvalaraSdk::EInvoicing::V1.configure do |config|
|
203
|
+
# See Documentation for Authorization section in main README.md for more auth examples.
|
204
|
+
config.bearer_token='<Your Avalara Identity Access Token>'
|
205
|
+
config.environment='sandbox'
|
206
|
+
config.app_name='testApp'
|
207
|
+
config.app_version='1.2.3'
|
208
|
+
config.machine_name='testMachine'
|
209
|
+
end
|
210
|
+
|
211
|
+
api_client = AvalaraSdk::ApiClient.new config
|
212
|
+
api_instance = AvalaraSdk::EInvoicing::V1::TradingPartnersApi.new api_client
|
213
|
+
|
214
|
+
avalara_version = '1.4' # String | The HTTP Header meant to specify the version of the API intended to be used.
|
215
|
+
create_trading_partners_batch_request = AvalaraSdk::EInvoicing::V1::CreateTradingPartnersBatchRequest.new # CreateTradingPartnersBatchRequest |
|
216
|
+
opts = {
|
217
|
+
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\".
|
218
|
+
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
219
|
+
}
|
220
|
+
|
221
|
+
begin
|
222
|
+
# Creates a batch of multiple trading partners.
|
223
|
+
result = api_instance.create_trading_partners_batch(avalara_version, create_trading_partners_batch_request, opts)
|
224
|
+
p result
|
225
|
+
rescue AvalaraSdk::ApiError => e
|
226
|
+
puts "Error when calling TradingPartnersApi->create_trading_partners_batch: #{e}"
|
227
|
+
end
|
228
|
+
```
|
229
|
+
|
230
|
+
#### Using the create_trading_partners_batch_with_http_info variant
|
231
|
+
|
232
|
+
This returns an Array which contains the response data, status code and headers.
|
233
|
+
|
234
|
+
> <Array(<CreateTradingPartnersBatch200Response>, Integer, Hash)> create_trading_partners_batch_with_http_info(avalara_version, create_trading_partners_batch_request, opts)
|
235
|
+
|
236
|
+
```ruby
|
237
|
+
begin
|
238
|
+
# Creates a batch of multiple trading partners.
|
239
|
+
data, status_code, headers = api_instance.create_trading_partners_batch_with_http_info(avalara_version, create_trading_partners_batch_request, opts)
|
240
|
+
p status_code # => 2xx
|
241
|
+
p headers # => { ... }
|
242
|
+
p data # => <CreateTradingPartnersBatch200Response>
|
243
|
+
rescue AvalaraSdk::EInvoicing::V1::ApiError => e
|
244
|
+
puts "Error when calling TradingPartnersApi->create_trading_partners_batch_with_http_info: #{e}"
|
245
|
+
end
|
246
|
+
```
|
247
|
+
|
248
|
+
### Parameters
|
249
|
+
|
250
|
+
| Name | Type | Description | Notes |
|
251
|
+
| ---- | ---- | ----------- | ----- |
|
252
|
+
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used. | |
|
253
|
+
| **create_trading_partners_batch_request** | [**CreateTradingPartnersBatchRequest**](CreateTradingPartnersBatchRequest.md) | | |
|
254
|
+
| **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] |
|
255
|
+
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
256
|
+
|
257
|
+
### Return type
|
258
|
+
|
259
|
+
[**CreateTradingPartnersBatch200Response**](CreateTradingPartnersBatch200Response.md)
|
260
|
+
|
261
|
+
### Authorization
|
262
|
+
|
263
|
+
[Bearer](../../../README.md#documentation-for-authorization)
|
264
|
+
|
265
|
+
### HTTP request headers
|
266
|
+
|
267
|
+
- **Content-Type**: application/json
|
268
|
+
- **Accept**: application/json
|
269
|
+
|
270
|
+
|
271
|
+
## delete_trading_partner
|
272
|
+
|
273
|
+
> delete_trading_partner(avalara_version, id, opts)
|
274
|
+
|
275
|
+
Deletes a trading partner using ID.
|
276
|
+
|
277
|
+
This endpoint deletes an existing trading partner identified by the provided ID.
|
278
|
+
|
279
|
+
### Examples
|
280
|
+
|
281
|
+
```ruby
|
282
|
+
require 'time'
|
283
|
+
require 'avalara_sdk'
|
284
|
+
# setup authorization
|
285
|
+
AvalaraSdk::EInvoicing::V1.configure do |config|
|
286
|
+
# See Documentation for Authorization section in main README.md for more auth examples.
|
287
|
+
config.bearer_token='<Your Avalara Identity Access Token>'
|
288
|
+
config.environment='sandbox'
|
289
|
+
config.app_name='testApp'
|
290
|
+
config.app_version='1.2.3'
|
291
|
+
config.machine_name='testMachine'
|
292
|
+
end
|
293
|
+
|
294
|
+
api_client = AvalaraSdk::ApiClient.new config
|
295
|
+
api_instance = AvalaraSdk::EInvoicing::V1::TradingPartnersApi.new api_client
|
296
|
+
|
297
|
+
avalara_version = '1.4' # String | The HTTP Header meant to specify the version of the API intended to be used.
|
298
|
+
id = 'id_example' # String | The ID of the trading partner which is being deleted.
|
299
|
+
opts = {
|
300
|
+
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\".
|
301
|
+
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
302
|
+
}
|
303
|
+
|
304
|
+
begin
|
305
|
+
# Deletes a trading partner using ID.
|
306
|
+
api_instance.delete_trading_partner(avalara_version, id, opts)
|
307
|
+
rescue AvalaraSdk::ApiError => e
|
308
|
+
puts "Error when calling TradingPartnersApi->delete_trading_partner: #{e}"
|
309
|
+
end
|
310
|
+
```
|
311
|
+
|
312
|
+
#### Using the delete_trading_partner_with_http_info variant
|
313
|
+
|
314
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
315
|
+
|
316
|
+
> <Array(nil, Integer, Hash)> delete_trading_partner_with_http_info(avalara_version, id, opts)
|
317
|
+
|
318
|
+
```ruby
|
319
|
+
begin
|
320
|
+
# Deletes a trading partner using ID.
|
321
|
+
data, status_code, headers = api_instance.delete_trading_partner_with_http_info(avalara_version, id, opts)
|
322
|
+
p status_code # => 2xx
|
323
|
+
p headers # => { ... }
|
324
|
+
p data # => nil
|
325
|
+
rescue AvalaraSdk::EInvoicing::V1::ApiError => e
|
326
|
+
puts "Error when calling TradingPartnersApi->delete_trading_partner_with_http_info: #{e}"
|
327
|
+
end
|
328
|
+
```
|
329
|
+
|
330
|
+
### Parameters
|
331
|
+
|
332
|
+
| Name | Type | Description | Notes |
|
333
|
+
| ---- | ---- | ----------- | ----- |
|
334
|
+
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used. | |
|
335
|
+
| **id** | **String** | The ID of the trading partner which is being deleted. | |
|
336
|
+
| **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] |
|
337
|
+
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
338
|
+
|
339
|
+
### Return type
|
340
|
+
|
341
|
+
nil (empty response body)
|
342
|
+
|
343
|
+
### Authorization
|
344
|
+
|
345
|
+
[Bearer](../../../README.md#documentation-for-authorization)
|
346
|
+
|
347
|
+
### HTTP request headers
|
348
|
+
|
349
|
+
- **Content-Type**: Not defined
|
350
|
+
- **Accept**: application/json
|
351
|
+
|
352
|
+
|
101
353
|
## download_batch_search_report
|
102
354
|
|
103
355
|
> File download_batch_search_report(avalara_version, id, opts)
|
104
356
|
|
105
|
-
|
357
|
+
Downloads batch search results in a csv file.
|
106
358
|
|
107
|
-
|
359
|
+
This endpoint downloads the report for a specific batch search using the batch search ID. It returns a CSV file containing up to 1,000 query results.
|
108
360
|
|
109
361
|
### Examples
|
110
362
|
|
@@ -124,15 +376,15 @@ end
|
|
124
376
|
api_client = AvalaraSdk::ApiClient.new config
|
125
377
|
api_instance = AvalaraSdk::EInvoicing::V1::TradingPartnersApi.new api_client
|
126
378
|
|
127
|
-
avalara_version = '1.
|
128
|
-
id = '2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99' # String | The ID of the batch search
|
379
|
+
avalara_version = '1.4' # String | The HTTP Header meant to specify the version of the API intended to be used.
|
380
|
+
id = '2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99' # String | The ID of the batch search for which the report should be downloaded.
|
129
381
|
opts = {
|
130
|
-
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\"
|
382
|
+
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\".
|
131
383
|
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
132
384
|
}
|
133
385
|
|
134
386
|
begin
|
135
|
-
#
|
387
|
+
# Downloads batch search results in a csv file.
|
136
388
|
result = api_instance.download_batch_search_report(avalara_version, id, opts)
|
137
389
|
p result
|
138
390
|
rescue AvalaraSdk::ApiError => e
|
@@ -148,7 +400,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
148
400
|
|
149
401
|
```ruby
|
150
402
|
begin
|
151
|
-
#
|
403
|
+
# Downloads batch search results in a csv file.
|
152
404
|
data, status_code, headers = api_instance.download_batch_search_report_with_http_info(avalara_version, id, opts)
|
153
405
|
p status_code # => 2xx
|
154
406
|
p headers # => { ... }
|
@@ -162,9 +414,9 @@ end
|
|
162
414
|
|
163
415
|
| Name | Type | Description | Notes |
|
164
416
|
| ---- | ---- | ----------- | ----- |
|
165
|
-
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used | |
|
166
|
-
| **id** | **String** | The ID of the batch search
|
167
|
-
| **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\"
|
417
|
+
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used. | |
|
418
|
+
| **id** | **String** | The ID of the batch search for which the report should be downloaded. | |
|
419
|
+
| **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] |
|
168
420
|
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
169
421
|
|
170
422
|
### Return type
|
@@ -185,9 +437,9 @@ end
|
|
185
437
|
|
186
438
|
> <BatchSearch> get_batch_search_detail(avalara_version, id, opts)
|
187
439
|
|
188
|
-
|
440
|
+
Returns the batch search details using ID.
|
189
441
|
|
190
|
-
This endpoint
|
442
|
+
This endpoint returns detailed information for a specific batch search using the provided ID. It is useful for tracking the status and progress of a previously initiated batch search operation.
|
191
443
|
|
192
444
|
### Examples
|
193
445
|
|
@@ -207,15 +459,15 @@ end
|
|
207
459
|
api_client = AvalaraSdk::ApiClient.new config
|
208
460
|
api_instance = AvalaraSdk::EInvoicing::V1::TradingPartnersApi.new api_client
|
209
461
|
|
210
|
-
avalara_version = '1.
|
462
|
+
avalara_version = '1.4' # String | The HTTP Header meant to specify the version of the API intended to be used.
|
211
463
|
id = '2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99' # String | The ID of the batch search that was submitted earlier.
|
212
464
|
opts = {
|
213
|
-
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\"
|
465
|
+
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\".
|
214
466
|
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
215
467
|
}
|
216
468
|
|
217
469
|
begin
|
218
|
-
#
|
470
|
+
# Returns the batch search details using ID.
|
219
471
|
result = api_instance.get_batch_search_detail(avalara_version, id, opts)
|
220
472
|
p result
|
221
473
|
rescue AvalaraSdk::ApiError => e
|
@@ -231,7 +483,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
231
483
|
|
232
484
|
```ruby
|
233
485
|
begin
|
234
|
-
#
|
486
|
+
# Returns the batch search details using ID.
|
235
487
|
data, status_code, headers = api_instance.get_batch_search_detail_with_http_info(avalara_version, id, opts)
|
236
488
|
p status_code # => 2xx
|
237
489
|
p headers # => { ... }
|
@@ -245,9 +497,9 @@ end
|
|
245
497
|
|
246
498
|
| Name | Type | Description | Notes |
|
247
499
|
| ---- | ---- | ----------- | ----- |
|
248
|
-
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used | |
|
500
|
+
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used. | |
|
249
501
|
| **id** | **String** | The ID of the batch search that was submitted earlier. | |
|
250
|
-
| **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\"
|
502
|
+
| **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] |
|
251
503
|
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
252
504
|
|
253
505
|
### Return type
|
@@ -268,9 +520,9 @@ end
|
|
268
520
|
|
269
521
|
> <BatchSearchListResponse> list_batch_searches(avalara_version, opts)
|
270
522
|
|
271
|
-
|
523
|
+
Lists all batch searches that were previously submitted.
|
272
524
|
|
273
|
-
This endpoint
|
525
|
+
This endpoint retrieves a list of all batch search operations that have been previously submitted. It returns details such as the batch search ID, status, creation date, and associated metadata. It is useful for tracking the progress of a previously initiated batch search operations.
|
274
526
|
|
275
527
|
### Examples
|
276
528
|
|
@@ -290,19 +542,19 @@ end
|
|
290
542
|
api_client = AvalaraSdk::ApiClient.new config
|
291
543
|
api_instance = AvalaraSdk::EInvoicing::V1::TradingPartnersApi.new api_client
|
292
544
|
|
293
|
-
avalara_version = '1.
|
545
|
+
avalara_version = '1.4' # String | The HTTP Header meant to specify the version of the API intended to be used.
|
294
546
|
opts = {
|
295
|
-
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\"
|
296
|
-
filter: 'name eq 'Batch_Search_Import_V4'', # String |
|
297
|
-
count: true, # Boolean | When set to true
|
298
|
-
top:
|
299
|
-
skip:
|
300
|
-
order_by: 'name desc', # String | The
|
547
|
+
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\".
|
548
|
+
filter: 'name eq 'Batch_Search_Import_V4'', # String | Filters the results by field name. Only the <code>eq</code> operator and the name field is supported. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/).
|
549
|
+
count: true, # Boolean | When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body.
|
550
|
+
top: 56, # Integer | The number of items to include in the result.
|
551
|
+
skip: 56, # Integer | The number of items to skip in the result.
|
552
|
+
order_by: 'name desc', # String | The <code>$orderBy</code> query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space.
|
301
553
|
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
302
554
|
}
|
303
555
|
|
304
556
|
begin
|
305
|
-
#
|
557
|
+
# Lists all batch searches that were previously submitted.
|
306
558
|
result = api_instance.list_batch_searches(avalara_version, opts)
|
307
559
|
p result
|
308
560
|
rescue AvalaraSdk::ApiError => e
|
@@ -318,7 +570,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
318
570
|
|
319
571
|
```ruby
|
320
572
|
begin
|
321
|
-
#
|
573
|
+
# Lists all batch searches that were previously submitted.
|
322
574
|
data, status_code, headers = api_instance.list_batch_searches_with_http_info(avalara_version, opts)
|
323
575
|
p status_code # => 2xx
|
324
576
|
p headers # => { ... }
|
@@ -332,13 +584,13 @@ end
|
|
332
584
|
|
333
585
|
| Name | Type | Description | Notes |
|
334
586
|
| ---- | ---- | ----------- | ----- |
|
335
|
-
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used | |
|
336
|
-
| **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\"
|
337
|
-
| **filter** | **String** |
|
338
|
-
| **count** | **Boolean** | When set to true
|
339
|
-
| **top** | **
|
340
|
-
| **skip** | **
|
341
|
-
| **order_by** | **String** | The
|
587
|
+
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used. | |
|
588
|
+
| **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] |
|
589
|
+
| **filter** | **String** | Filters the results by field name. Only the <code>eq</code> operator and the name field is supported. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/). | [optional] |
|
590
|
+
| **count** | **Boolean** | When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body. | [optional] |
|
591
|
+
| **top** | **Integer** | The number of items to include in the result. | [optional] |
|
592
|
+
| **skip** | **Integer** | The number of items to skip in the result. | [optional] |
|
593
|
+
| **order_by** | **String** | The <code>$orderBy</code> query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. | [optional] |
|
342
594
|
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
343
595
|
|
344
596
|
### Return type
|
@@ -357,11 +609,11 @@ end
|
|
357
609
|
|
358
610
|
## search_participants
|
359
611
|
|
360
|
-
> <
|
612
|
+
> <SearchParticipants200Response> search_participants(avalara_version, search, opts)
|
361
613
|
|
362
614
|
Returns a list of participants matching the input query.
|
363
615
|
|
364
|
-
This endpoint
|
616
|
+
This endpoint retrieves a list of trading partners that match the specified search criteria. It supports filtering, search text, and other relevant query parameters to narrow down the results.
|
365
617
|
|
366
618
|
### Examples
|
367
619
|
|
@@ -381,15 +633,15 @@ end
|
|
381
633
|
api_client = AvalaraSdk::ApiClient.new config
|
382
634
|
api_instance = AvalaraSdk::EInvoicing::V1::TradingPartnersApi.new api_client
|
383
635
|
|
384
|
-
avalara_version = '1.
|
385
|
-
search = 'Acme and 7726627177 or BMW' # String | Search by value supports logical AND
|
636
|
+
avalara_version = '1.4' # String | The HTTP Header meant to specify the version of the API intended to be used.
|
637
|
+
search = 'Acme and 7726627177 or BMW' # String | Search by value supports logical <code>AND</code> / <code>OR</code> operators. Search is performed only over the name and identifier value fields. For more information, refer to [Query options overview - OData.](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search).
|
386
638
|
opts = {
|
387
|
-
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\"
|
388
|
-
count: true, # Boolean | When set to true
|
389
|
-
filter: 'network eq 'Peppol' and country eq 'Australia'', # String |
|
390
|
-
top:
|
391
|
-
skip:
|
392
|
-
order_by: 'name desc', # String | The
|
639
|
+
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\".
|
640
|
+
count: true, # Boolean | When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body.
|
641
|
+
filter: 'network eq 'Peppol' and country eq 'Australia'', # String | Filters the results using the <code>eq</code> operator. Supported fields: <code>network</code>, <code>country</code>, <code>documentType</code>, <code>idType</code>. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/).
|
642
|
+
top: 56, # Integer | The number of items to include in the result.
|
643
|
+
skip: 56, # Integer | The number of items to skip in the result.
|
644
|
+
order_by: 'name desc', # String | The <code>$orderBy</code> query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space.
|
393
645
|
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
394
646
|
}
|
395
647
|
|
@@ -406,7 +658,7 @@ end
|
|
406
658
|
|
407
659
|
This returns an Array which contains the response data, status code and headers.
|
408
660
|
|
409
|
-
> <Array(<
|
661
|
+
> <Array(<SearchParticipants200Response>, Integer, Hash)> search_participants_with_http_info(avalara_version, search, opts)
|
410
662
|
|
411
663
|
```ruby
|
412
664
|
begin
|
@@ -414,7 +666,7 @@ begin
|
|
414
666
|
data, status_code, headers = api_instance.search_participants_with_http_info(avalara_version, search, opts)
|
415
667
|
p status_code # => 2xx
|
416
668
|
p headers # => { ... }
|
417
|
-
p data # => <
|
669
|
+
p data # => <SearchParticipants200Response>
|
418
670
|
rescue AvalaraSdk::EInvoicing::V1::ApiError => e
|
419
671
|
puts "Error when calling TradingPartnersApi->search_participants_with_http_info: #{e}"
|
420
672
|
end
|
@@ -424,19 +676,19 @@ end
|
|
424
676
|
|
425
677
|
| Name | Type | Description | Notes |
|
426
678
|
| ---- | ---- | ----------- | ----- |
|
427
|
-
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used | |
|
428
|
-
| **search** | **String** | Search by value supports logical AND
|
429
|
-
| **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\"
|
430
|
-
| **count** | **Boolean** | When set to true
|
431
|
-
| **filter** | **String** |
|
432
|
-
| **top** | **
|
433
|
-
| **skip** | **
|
434
|
-
| **order_by** | **String** | The
|
679
|
+
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used. | |
|
680
|
+
| **search** | **String** | Search by value supports logical <code>AND</code> / <code>OR</code> operators. Search is performed only over the name and identifier value fields. For more information, refer to [Query options overview - OData.](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search). | |
|
681
|
+
| **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] |
|
682
|
+
| **count** | **Boolean** | When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body. | [optional] |
|
683
|
+
| **filter** | **String** | Filters the results using the <code>eq</code> operator. Supported fields: <code>network</code>, <code>country</code>, <code>documentType</code>, <code>idType</code>. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/). | [optional] |
|
684
|
+
| **top** | **Integer** | The number of items to include in the result. | [optional] |
|
685
|
+
| **skip** | **Integer** | The number of items to skip in the result. | [optional] |
|
686
|
+
| **order_by** | **String** | The <code>$orderBy</code> query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. | [optional] |
|
435
687
|
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
436
688
|
|
437
689
|
### Return type
|
438
690
|
|
439
|
-
[**
|
691
|
+
[**SearchParticipants200Response**](SearchParticipants200Response.md)
|
440
692
|
|
441
693
|
### Authorization
|
442
694
|
|
@@ -447,3 +699,88 @@ end
|
|
447
699
|
- **Content-Type**: Not defined
|
448
700
|
- **Accept**: application/json
|
449
701
|
|
702
|
+
|
703
|
+
## update_trading_partner
|
704
|
+
|
705
|
+
> <UpdateTradingPartner200Response> update_trading_partner(avalara_version, id, trading_partner, opts)
|
706
|
+
|
707
|
+
Updates a trading partner using ID.
|
708
|
+
|
709
|
+
This endpoint updates the details of an existing trading partner specified by the provided ID. It performs a full update, and the request body must include all required fields.
|
710
|
+
|
711
|
+
### Examples
|
712
|
+
|
713
|
+
```ruby
|
714
|
+
require 'time'
|
715
|
+
require 'avalara_sdk'
|
716
|
+
# setup authorization
|
717
|
+
AvalaraSdk::EInvoicing::V1.configure do |config|
|
718
|
+
# See Documentation for Authorization section in main README.md for more auth examples.
|
719
|
+
config.bearer_token='<Your Avalara Identity Access Token>'
|
720
|
+
config.environment='sandbox'
|
721
|
+
config.app_name='testApp'
|
722
|
+
config.app_version='1.2.3'
|
723
|
+
config.machine_name='testMachine'
|
724
|
+
end
|
725
|
+
|
726
|
+
api_client = AvalaraSdk::ApiClient.new config
|
727
|
+
api_instance = AvalaraSdk::EInvoicing::V1::TradingPartnersApi.new api_client
|
728
|
+
|
729
|
+
avalara_version = '1.4' # String | The HTTP Header meant to specify the version of the API intended to be used.
|
730
|
+
id = 'id_example' # String | The ID of the trading partner which is being updated.
|
731
|
+
trading_partner = AvalaraSdk::EInvoicing::V1::TradingPartner.new({name: 'name_example', identifiers: [AvalaraSdk::EInvoicing::V1::Identifier.new({name: 'name_example', value: 'value_example'})], addresses: [AvalaraSdk::EInvoicing::V1::Address.new({country: 'country_example'})], supported_document_types: [AvalaraSdk::EInvoicing::V1::SupportedDocumentTypes.new({value: 'value_example', supported_by_trading_partner: false})]}) # TradingPartner |
|
732
|
+
opts = {
|
733
|
+
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\".
|
734
|
+
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
735
|
+
}
|
736
|
+
|
737
|
+
begin
|
738
|
+
# Updates a trading partner using ID.
|
739
|
+
result = api_instance.update_trading_partner(avalara_version, id, trading_partner, opts)
|
740
|
+
p result
|
741
|
+
rescue AvalaraSdk::ApiError => e
|
742
|
+
puts "Error when calling TradingPartnersApi->update_trading_partner: #{e}"
|
743
|
+
end
|
744
|
+
```
|
745
|
+
|
746
|
+
#### Using the update_trading_partner_with_http_info variant
|
747
|
+
|
748
|
+
This returns an Array which contains the response data, status code and headers.
|
749
|
+
|
750
|
+
> <Array(<UpdateTradingPartner200Response>, Integer, Hash)> update_trading_partner_with_http_info(avalara_version, id, trading_partner, opts)
|
751
|
+
|
752
|
+
```ruby
|
753
|
+
begin
|
754
|
+
# Updates a trading partner using ID.
|
755
|
+
data, status_code, headers = api_instance.update_trading_partner_with_http_info(avalara_version, id, trading_partner, opts)
|
756
|
+
p status_code # => 2xx
|
757
|
+
p headers # => { ... }
|
758
|
+
p data # => <UpdateTradingPartner200Response>
|
759
|
+
rescue AvalaraSdk::EInvoicing::V1::ApiError => e
|
760
|
+
puts "Error when calling TradingPartnersApi->update_trading_partner_with_http_info: #{e}"
|
761
|
+
end
|
762
|
+
```
|
763
|
+
|
764
|
+
### Parameters
|
765
|
+
|
766
|
+
| Name | Type | Description | Notes |
|
767
|
+
| ---- | ---- | ----------- | ----- |
|
768
|
+
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used. | |
|
769
|
+
| **id** | **String** | The ID of the trading partner which is being updated. | |
|
770
|
+
| **trading_partner** | [**TradingPartner**](TradingPartner.md) | | |
|
771
|
+
| **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] |
|
772
|
+
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
773
|
+
|
774
|
+
### Return type
|
775
|
+
|
776
|
+
[**UpdateTradingPartner200Response**](UpdateTradingPartner200Response.md)
|
777
|
+
|
778
|
+
### Authorization
|
779
|
+
|
780
|
+
[Bearer](../../../README.md#documentation-for-authorization)
|
781
|
+
|
782
|
+
### HTTP request headers
|
783
|
+
|
784
|
+
- **Content-Type**: application/json
|
785
|
+
- **Accept**: application/json
|
786
|
+
|