From 5a3cfffc09ca05c1b3f7d9f39c7de87ab065c0c7 Mon Sep 17 00:00:00 2001 From: Lexander Gonzalez Date: Fri, 14 Mar 2025 08:49:40 +0100 Subject: [PATCH 1/6] feat: adding new api spec --- generation/swagger.json | 234 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 229 insertions(+), 5 deletions(-) diff --git a/generation/swagger.json b/generation/swagger.json index 54262a7..b34395a 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202501091801", + "version": "1.1.202503131403", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -1790,6 +1790,49 @@ } } }, + "/v1/documents/combined_labels": { + "summary": "Created Combined Label Document", + "description": "Download a combined label file", + "post": { + "summary": "Created Combined Label Document", + "description": "Download a combined label file", + "tags": [ + "labels" + ], + "operationId": "create_combined_label_document", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/create_combined_label_document_request_body" + } + } + } + }, + "responses": { + "200": { + "description": "The requested object creation was a success.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/create_combined_label_document_response_body.yaml" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400_error_response" + }, + "404": { + "$ref": "#/components/responses/404_error_response" + }, + "500": { + "$ref": "#/components/responses/500_error_response" + } + } + } + }, "/v1/downloads/{dir}/{subdir}/{filename}": { "summary": "File Download", "description": "This endpoint is used to download forms that are generated in the various pdf, png, zpl formats\nsuch as labels and batches\n", @@ -4885,6 +4928,45 @@ "$ref": "#/components/responses/500_error_response" } } + }, + "post": { + "summary": "Create a New Tag", + "description": "Create a new tag for customizing how you track your shipments.", + "tags": [ + "tags" + ], + "operationId": "create_tag", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/create_tag_request_body" + } + } + } + }, + "responses": { + "200": { + "description": "The requested object creation was a success.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/create_tag_response_body" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400_error_response" + }, + "404": { + "$ref": "#/components/responses/404_error_response" + }, + "500": { + "$ref": "#/components/responses/500_error_response" + } + } } }, "/v1/tags/{tag_name}": { @@ -4902,7 +4984,7 @@ ], "post": { "summary": "Create a New Tag", - "description": "Create a new Tag for customizing how you track your shipments", + "description": "Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead)", "tags": [ "tags" ], @@ -5665,9 +5747,7 @@ "validation", "security", "system", - "integrations", - "wallet", - "funding_sources" + "integrations" ], "description": "The type of error\n" }, @@ -9611,6 +9691,56 @@ "title": "connect_insurer_response_body", "type": "object" }, + "create_combined_label_document_request_body": { + "title": "create_combined_label_document_request_body", + "type": "object", + "description": "A create combined label document request body", + "additionalProperties": false, + "properties": { + "label_ids": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ] + }, + "description": "The list of up to 30 label ids to include in the combined label document.\nNote that to avoid response size limits, you should only expect to be able to combine 30 single page labels similar in size to that of USPS labels.\n" + }, + "label_format": { + "enum": [ + "pdf" + ], + "type": "string", + "description": "The file format for the combined label document; note that currently only `\"pdf\"` is supported." + }, + "label_download_type": { + "enum": [ + "inline" + ], + "type": "string", + "description": "The download type for the combined label document; note that currently only `\"inline\"` is supported." + } + } + }, + "create_combined_label_document_response_body.yaml": { + "title": "create_combined_label_document_response_body.yaml", + "type": "object", + "description": "A create combined label document response body", + "additionalProperties": false, + "properties": { + "label_download": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/label_download" + } + ], + "description": "The download for the combined label document" + } + } + }, "download_file_pdf_response_body": { "title": "download_file_pdf_response_body", "type": "string", @@ -10161,6 +10291,15 @@ ], "description": "The current status of the package, such as `in_transit` or `delivered`" }, + "confirmation": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/delivery_confirmation" + } + ], + "description": "The type of delivery confirmation that is required for this shipment." + }, "label_download": { "allOf": [ { @@ -10969,6 +11108,14 @@ ], "description": "Discount for shipment." }, + "estimated_import_charges": { + "allOf": [ + { + "$ref": "#/components/schemas/estimated_import_charges" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, "other_charge": { "allOf": [ { @@ -10983,6 +11130,30 @@ } } }, + "estimated_import_charges": { + "title": "estimated_import_charges", + "type": "object", + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "additionalProperties": false, + "properties": { + "taxes": { + "allOf": [ + { + "$ref": "#/components/schemas/monetary_value" + } + ], + "description": "Estimated import taxes." + }, + "duties": { + "allOf": [ + { + "$ref": "#/components/schemas/monetary_value" + } + ], + "description": "Estimated import duties." + } + } + }, "importer_of_records": { "title": "importer_of_records", "type": "object", @@ -12226,6 +12397,15 @@ ], "description": "The current status of the package, such as `in_transit` or `delivered`" }, + "confirmation": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/delivery_confirmation" + } + ], + "description": "The type of delivery confirmation that is required for this shipment." + }, "label_download": { "allOf": [ { @@ -12589,11 +12769,23 @@ ], "additionalProperties": false, "properties": { + "tag_id": { + "type": "int", + "minLength": 1, + "example": 8712, + "description": "An integer uniquely identifying a tag." + }, "name": { "type": "string", "minLength": 1, "example": "Fragile", "description": "The tag name." + }, + "color": { + "type": "string", + "minLength": 1, + "example": "#FF0000", + "description": "A hex-coded string identifying the color of the tag." } } }, @@ -14634,6 +14826,15 @@ "is_return": { "type": "boolean", "description": "Indicate if it's a return shipment" + }, + "rate_type": { + "type": "string", + "enum": [ + "check", + "shipment", + "quick" + ], + "description": "Indicates what type of rating to perform" } } }, @@ -16674,6 +16875,29 @@ } } }, + "create_tag_request_body": { + "title": "create_tag_request_body", + "type": "object", + "description": "A create tag request body", + "required": [ + "name" + ], + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "minLength": 1, + "example": "Fragile", + "description": "The tag name." + }, + "color": { + "type": "string", + "minLength": 1, + "example": "#FF0000", + "description": "A hex-coded string identifying the color of the tag." + } + } + }, "create_tag_response_body": { "title": "create_tag_response_body", "type": "object", From ac1936bcb946242adf7d8fd4527116385b23f4f0 Mon Sep 17 00:00:00 2001 From: Lexander Gonzalez Date: Fri, 14 Mar 2025 09:30:16 +0100 Subject: [PATCH 2/6] feat: fixing swagger.json --- generation/swagger.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/generation/swagger.json b/generation/swagger.json index b34395a..ecc58cb 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -12770,8 +12770,10 @@ "additionalProperties": false, "properties": { "tag_id": { - "type": "int", - "minLength": 1, + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 1, "example": 8712, "description": "An integer uniquely identifying a tag." }, From 94da97e783912d283f36741052caf2c5fdeae1b4 Mon Sep 17 00:00:00 2001 From: Lexander Gonzalez Date: Fri, 14 Mar 2025 09:31:06 +0100 Subject: [PATCH 3/6] feat: generating sdk files --- .openapi-generator/FILES | 8 + README.md | 190 +++++++++--------- ShipEngineSDK/Api/LabelsApi.cs | 63 ++++++ ShipEngineSDK/Api/TagsApi.cs | 83 +++++++- .../CreateCombinedLabelDocumentRequestBody.cs | 185 +++++++++++++++++ ...teCombinedLabelDocumentResponseBodyYaml.cs | 64 ++++++ .../Model/CreateLabelFromRateResponseBody.cs | 33 ++- .../CreateLabelFromShipmentResponseBody.cs | 33 ++- .../Model/CreateLabelResponseBody.cs | 25 ++- .../Model/CreateReturnLabelResponseBody.cs | 33 ++- ShipEngineSDK/Model/CreateTagRequestBody.cs | 75 +++++++ ShipEngineSDK/Model/CreateTagResponseBody.cs | 25 +++ ShipEngineSDK/Model/ErrorType.cs | 12 -- ShipEngineSDK/Model/EstimatedImportCharges.cs | 69 +++++++ ...etLabelByExternalShipmentIdResponseBody.cs | 33 ++- .../Model/GetLabelByIdResponseBody.cs | 33 ++- .../Model/InvoiceAdditionalDetails.cs | 16 +- ShipEngineSDK/Model/Label.cs | 33 ++- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 7 + ShipEngineSDK/Model/RateRequestBody.cs | 76 ++++++- ShipEngineSDK/Model/Tag.cs | 25 +++ docs/apis/AccountApi.md | 4 +- docs/apis/AddressesApi.md | 4 +- docs/apis/BatchesApi.md | 8 +- docs/apis/CarrierAccountsApi.md | 4 +- docs/apis/CarriersApi.md | 2 +- docs/apis/InsuranceApi.md | 4 +- docs/apis/LabelsApi.md | 65 +++++- docs/apis/ManifestsApi.md | 4 +- docs/apis/PackagePickupsApi.md | 2 +- docs/apis/PackageTypesApi.md | 4 +- docs/apis/RatesApi.md | 6 +- docs/apis/ServicePointsApi.md | 2 +- docs/apis/ShipmentsApi.md | 8 +- docs/apis/TagsApi.md | 67 +++++- docs/apis/WarehousesApi.md | 6 +- docs/apis/WebhooksApi.md | 4 +- .../CreateCombinedLabelDocumentRequestBody.md | 11 + ...teCombinedLabelDocumentResponseBodyYaml.md | 9 + .../models/CreateLabelFromRateResponseBody.md | 1 + .../CreateLabelFromShipmentResponseBody.md | 1 + docs/models/CreateLabelResponseBody.md | 1 + docs/models/CreateReturnLabelResponseBody.md | 1 + docs/models/CreateTagRequestBody.md | 10 + docs/models/CreateTagResponseBody.md | 2 + docs/models/EstimatedImportCharges.md | 10 + ...etLabelByExternalShipmentIdResponseBody.md | 1 + docs/models/GetLabelByIdResponseBody.md | 1 + docs/models/InvoiceAdditionalDetails.md | 1 + docs/models/Label.md | 1 + docs/models/RateRequestBody.md | 1 + docs/models/Tag.md | 2 + 52 files changed, 1134 insertions(+), 234 deletions(-) create mode 100644 ShipEngineSDK/Model/CreateCombinedLabelDocumentRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreateCombinedLabelDocumentResponseBodyYaml.cs create mode 100644 ShipEngineSDK/Model/CreateTagRequestBody.cs create mode 100644 ShipEngineSDK/Model/EstimatedImportCharges.cs create mode 100644 docs/models/CreateCombinedLabelDocumentRequestBody.md create mode 100644 docs/models/CreateCombinedLabelDocumentResponseBodyYaml.md create mode 100644 docs/models/CreateTagRequestBody.md create mode 100644 docs/models/EstimatedImportCharges.md diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index f571e18..670864a 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -96,6 +96,8 @@ ShipEngineSDK/Model/CreateAndValidateShipment.cs ShipEngineSDK/Model/CreateBatchRequest.cs ShipEngineSDK/Model/CreateBatchRequestBody.cs ShipEngineSDK/Model/CreateBatchResponseBody.cs +ShipEngineSDK/Model/CreateCombinedLabelDocumentRequestBody.cs +ShipEngineSDK/Model/CreateCombinedLabelDocumentResponseBodyYaml.cs ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs @@ -113,6 +115,7 @@ ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs ShipEngineSDK/Model/CreateShipmentsRequestBody.cs ShipEngineSDK/Model/CreateShipmentsResponseBody.cs +ShipEngineSDK/Model/CreateTagRequestBody.cs ShipEngineSDK/Model/CreateTagResponseBody.cs ShipEngineSDK/Model/CreateWarehouseRequestBody.cs ShipEngineSDK/Model/CreateWarehouseResponseBody.cs @@ -138,6 +141,7 @@ ShipEngineSDK/Model/ErrorSource.cs ShipEngineSDK/Model/ErrorType.cs ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs ShipEngineSDK/Model/EstimateRatesRequestBody.cs +ShipEngineSDK/Model/EstimatedImportCharges.cs ShipEngineSDK/Model/FedexAccountSettings.cs ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs ShipEngineSDK/Model/FedexPickupType.cs @@ -424,6 +428,8 @@ docs/models/CreateAndValidateShipment.md docs/models/CreateBatchRequest.md docs/models/CreateBatchRequestBody.md docs/models/CreateBatchResponseBody.md +docs/models/CreateCombinedLabelDocumentRequestBody.md +docs/models/CreateCombinedLabelDocumentResponseBodyYaml.md docs/models/CreateLabelFromRateRequestBody.md docs/models/CreateLabelFromRateResponseBody.md docs/models/CreateLabelFromShipmentRequestBody.md @@ -441,6 +447,7 @@ docs/models/CreateReturnLabelResponseBody.md docs/models/CreateShipmentResponseBodyFields.md docs/models/CreateShipmentsRequestBody.md docs/models/CreateShipmentsResponseBody.md +docs/models/CreateTagRequestBody.md docs/models/CreateTagResponseBody.md docs/models/CreateWarehouseRequestBody.md docs/models/CreateWarehouseResponseBody.md @@ -466,6 +473,7 @@ docs/models/ErrorSource.md docs/models/ErrorType.md docs/models/ErrorWithLabelIdResponseBody.md docs/models/EstimateRatesRequestBody.md +docs/models/EstimatedImportCharges.md docs/models/FedexAccountSettings.md docs/models/FedexAccountSettingsRequestBody.md docs/models/FedexPickupType.md diff --git a/README.md b/README.md index 05833c5..1f1d127 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ var shipengine = new ShipEngine("___YOUR_API_KEY_HERE__"); This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 1.1.202501091801 +- API version: 1.1.202503131403 - SDK version: 3.0.0 - Generator version: 7.7.0 - Build package: org.openapitools.codegen.languages.CSharpClientCodegen @@ -52,99 +52,101 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap API | Method | Description ------------ | ------------- | ------------- -*Account* | [**CreateAccountImage**](docs//apis/AccountApi.md#createaccountimage) | Create an Account Image -*Account* | [**DeleteAccountImageById**](docs//apis/AccountApi.md#deleteaccountimagebyid) | Delete Account Image By Id -*Account* | [**GetAccountSettingsImagesById**](docs//apis/AccountApi.md#getaccountsettingsimagesbyid) | Get Account Image By ID -*Account* | [**ListAccountImages**](docs//apis/AccountApi.md#listaccountimages) | List Account Images -*Account* | [**ListAccountSettings**](docs//apis/AccountApi.md#listaccountsettings) | List Account Settings -*Account* | [**UpdateAccountSettingsImagesById**](docs//apis/AccountApi.md#updateaccountsettingsimagesbyid) | Update Account Image By ID -*Addresses* | [**ParseAddress**](docs//apis/AddressesApi.md#parseaddress) | Parse an address -*Addresses* | [**ValidateAddress**](docs//apis/AddressesApi.md#validateaddress) | Validate An Address -*Batches* | [**AddToBatch**](docs//apis/BatchesApi.md#addtobatch) | Add to a Batch -*Batches* | [**CreateBatch**](docs//apis/BatchesApi.md#createbatch) | Create A Batch -*Batches* | [**DeleteBatch**](docs//apis/BatchesApi.md#deletebatch) | Delete Batch By Id -*Batches* | [**GetBatchByExternalId**](docs//apis/BatchesApi.md#getbatchbyexternalid) | Get Batch By External ID -*Batches* | [**GetBatchById**](docs//apis/BatchesApi.md#getbatchbyid) | Get Batch By ID -*Batches* | [**ListBatchErrors**](docs//apis/BatchesApi.md#listbatcherrors) | Get Batch Errors -*Batches* | [**ListBatches**](docs//apis/BatchesApi.md#listbatches) | List Batches -*Batches* | [**ProcessBatch**](docs//apis/BatchesApi.md#processbatch) | Process Batch ID Labels -*Batches* | [**RemoveFromBatch**](docs//apis/BatchesApi.md#removefrombatch) | Remove From Batch -*Batches* | [**UpdateBatch**](docs//apis/BatchesApi.md#updatebatch) | Update Batch By Id -*CarrierAccounts* | [**ConnectCarrier**](docs//apis/CarrierAccountsApi.md#connectcarrier) | Connect a carrier account -*CarrierAccounts* | [**DisconnectCarrier**](docs//apis/CarrierAccountsApi.md#disconnectcarrier) | Disconnect a carrier -*CarrierAccounts* | [**GetCarrierSettings**](docs//apis/CarrierAccountsApi.md#getcarriersettings) | Get carrier settings -*CarrierAccounts* | [**UpdateCarrierSettings**](docs//apis/CarrierAccountsApi.md#updatecarriersettings) | Update carrier settings -*Carriers* | [**AddFundsToCarrier**](docs//apis/CarriersApi.md#addfundstocarrier) | Add Funds To Carrier -*Carriers* | [**DisconnectCarrierById**](docs//apis/CarriersApi.md#disconnectcarrierbyid) | Disconnect Carrier by ID -*Carriers* | [**GetCarrierById**](docs//apis/CarriersApi.md#getcarrierbyid) | Get Carrier By ID -*Carriers* | [**GetCarrierOptions**](docs//apis/CarriersApi.md#getcarrieroptions) | Get Carrier Options -*Carriers* | [**ListCarrierPackageTypes**](docs//apis/CarriersApi.md#listcarrierpackagetypes) | List Carrier Package Types -*Carriers* | [**ListCarrierServices**](docs//apis/CarriersApi.md#listcarrierservices) | List Carrier Services -*Carriers* | [**ListCarriers**](docs//apis/CarriersApi.md#listcarriers) | List Carriers -*Downloads* | [**DownloadFile**](docs//apis/DownloadsApi.md#downloadfile) | Download File -*Insurance* | [**AddFundsToInsurance**](docs//apis/InsuranceApi.md#addfundstoinsurance) | Add Funds To Insurance -*Insurance* | [**ConnectInsurer**](docs//apis/InsuranceApi.md#connectinsurer) | Connect a Shipsurance Account -*Insurance* | [**DisconnectInsurer**](docs//apis/InsuranceApi.md#disconnectinsurer) | Disconnect a Shipsurance Account -*Insurance* | [**GetInsuranceBalance**](docs//apis/InsuranceApi.md#getinsurancebalance) | Get Insurance Funds Balance -*Labels* | [**CreateLabel**](docs//apis/LabelsApi.md#createlabel) | Purchase Label -*Labels* | [**CreateLabelFromRate**](docs//apis/LabelsApi.md#createlabelfromrate) | Purchase Label with Rate ID -*Labels* | [**CreateLabelFromShipment**](docs//apis/LabelsApi.md#createlabelfromshipment) | Purchase Label with Shipment ID -*Labels* | [**CreateReturnLabel**](docs//apis/LabelsApi.md#createreturnlabel) | Create a return label -*Labels* | [**GetLabelByExternalShipmentId**](docs//apis/LabelsApi.md#getlabelbyexternalshipmentid) | Get Label By External Shipment ID -*Labels* | [**GetLabelById**](docs//apis/LabelsApi.md#getlabelbyid) | Get Label By ID -*Labels* | [**GetTrackingLogFromLabel**](docs//apis/LabelsApi.md#gettrackinglogfromlabel) | Get Label Tracking Information -*Labels* | [**ListLabels**](docs//apis/LabelsApi.md#listlabels) | List labels -*Labels* | [**VoidLabel**](docs//apis/LabelsApi.md#voidlabel) | Void a Label By ID -*Manifests* | [**CreateManifest**](docs//apis/ManifestsApi.md#createmanifest) | Create Manifest -*Manifests* | [**GetManifestById**](docs//apis/ManifestsApi.md#getmanifestbyid) | Get Manifest By Id -*Manifests* | [**GetManifestRequestById**](docs//apis/ManifestsApi.md#getmanifestrequestbyid) | Get Manifest Request By Id -*Manifests* | [**ListManifests**](docs//apis/ManifestsApi.md#listmanifests) | List Manifests -*PackagePickups* | [**DeleteScheduledPickup**](docs//apis/PackagePickupsApi.md#deletescheduledpickup) | Delete a Scheduled Pickup -*PackagePickups* | [**GetPickupById**](docs//apis/PackagePickupsApi.md#getpickupbyid) | Get Pickup By ID -*PackagePickups* | [**ListScheduledPickups**](docs//apis/PackagePickupsApi.md#listscheduledpickups) | List Scheduled Pickups -*PackagePickups* | [**SchedulePickup**](docs//apis/PackagePickupsApi.md#schedulepickup) | Schedule a Pickup -*PackageTypes* | [**CreatePackageType**](docs//apis/PackageTypesApi.md#createpackagetype) | Create Custom Package Type -*PackageTypes* | [**DeletePackageType**](docs//apis/PackageTypesApi.md#deletepackagetype) | Delete A Custom Package By ID -*PackageTypes* | [**GetPackageTypeById**](docs//apis/PackageTypesApi.md#getpackagetypebyid) | Get Custom Package Type By ID -*PackageTypes* | [**ListPackageTypes**](docs//apis/PackageTypesApi.md#listpackagetypes) | List Custom Package Types -*PackageTypes* | [**UpdatePackageType**](docs//apis/PackageTypesApi.md#updatepackagetype) | Update Custom Package Type By ID -*Rates* | [**CalculateRates**](docs//apis/RatesApi.md#calculaterates) | Get Shipping Rates -*Rates* | [**CompareBulkRates**](docs//apis/RatesApi.md#comparebulkrates) | Get Bulk Rates -*Rates* | [**EstimateRates**](docs//apis/RatesApi.md#estimaterates) | Estimate Rates -*Rates* | [**GetRateById**](docs//apis/RatesApi.md#getratebyid) | Get Rate By ID -*ServicePoints* | [**ServicePointsGetById**](docs//apis/ServicePointsApi.md#servicepointsgetbyid) | Get Service Point By ID -*ServicePoints* | [**ServicePointsList**](docs//apis/ServicePointsApi.md#servicepointslist) | List Service Points -*Shipments* | [**CancelShipments**](docs//apis/ShipmentsApi.md#cancelshipments) | Cancel a Shipment -*Shipments* | [**CreateShipments**](docs//apis/ShipmentsApi.md#createshipments) | Create Shipments -*Shipments* | [**GetShipmentByExternalId**](docs//apis/ShipmentsApi.md#getshipmentbyexternalid) | Get Shipment By External ID -*Shipments* | [**GetShipmentById**](docs//apis/ShipmentsApi.md#getshipmentbyid) | Get Shipment By ID -*Shipments* | [**ListShipmentRates**](docs//apis/ShipmentsApi.md#listshipmentrates) | Get Shipment Rates -*Shipments* | [**ListShipments**](docs//apis/ShipmentsApi.md#listshipments) | List Shipments -*Shipments* | [**ParseShipment**](docs//apis/ShipmentsApi.md#parseshipment) | Parse shipping info -*Shipments* | [**ShipmentsListTags**](docs//apis/ShipmentsApi.md#shipmentslisttags) | Get Shipment Tags -*Shipments* | [**ShipmentsUpdateTags**](docs//apis/ShipmentsApi.md#shipmentsupdatetags) | Update Shipments Tags -*Shipments* | [**TagShipment**](docs//apis/ShipmentsApi.md#tagshipment) | Add Tag to Shipment -*Shipments* | [**UntagShipment**](docs//apis/ShipmentsApi.md#untagshipment) | Remove Tag from Shipment -*Shipments* | [**UpdateShipment**](docs//apis/ShipmentsApi.md#updateshipment) | Update Shipment By ID -*Tags* | [**CreateTag**](docs//apis/TagsApi.md#createtag) | Create a New Tag -*Tags* | [**DeleteTag**](docs//apis/TagsApi.md#deletetag) | Delete Tag -*Tags* | [**ListTags**](docs//apis/TagsApi.md#listtags) | Get Tags -*Tags* | [**RenameTag**](docs//apis/TagsApi.md#renametag) | Update Tag Name -*Tokens* | [**TokensGetEphemeralToken**](docs//apis/TokensApi.md#tokensgetephemeraltoken) | Get Ephemeral Token -*Tracking* | [**GetTrackingLog**](docs//apis/TrackingApi.md#gettrackinglog) | Get Tracking Information -*Tracking* | [**StartTracking**](docs//apis/TrackingApi.md#starttracking) | Start Tracking a Package -*Tracking* | [**StopTracking**](docs//apis/TrackingApi.md#stoptracking) | Stop Tracking a Package -*Warehouses* | [**CreateWarehouse**](docs//apis/WarehousesApi.md#createwarehouse) | Create Warehouse -*Warehouses* | [**DeleteWarehouse**](docs//apis/WarehousesApi.md#deletewarehouse) | Delete Warehouse By ID -*Warehouses* | [**GetWarehouseById**](docs//apis/WarehousesApi.md#getwarehousebyid) | Get Warehouse By Id -*Warehouses* | [**ListWarehouses**](docs//apis/WarehousesApi.md#listwarehouses) | List Warehouses -*Warehouses* | [**UpdateWarehouse**](docs//apis/WarehousesApi.md#updatewarehouse) | Update Warehouse By Id -*Warehouses* | [**UpdateWarehouseSettings**](docs//apis/WarehousesApi.md#updatewarehousesettings) | Update Warehouse Settings -*Webhooks* | [**CreateWebhook**](docs//apis/WebhooksApi.md#createwebhook) | Create a Webhook -*Webhooks* | [**DeleteWebhook**](docs//apis/WebhooksApi.md#deletewebhook) | Delete Webhook By ID -*Webhooks* | [**GetWebhookById**](docs//apis/WebhooksApi.md#getwebhookbyid) | Get Webhook By ID -*Webhooks* | [**ListWebhooks**](docs//apis/WebhooksApi.md#listwebhooks) | List Webhooks -*Webhooks* | [**UpdateWebhook**](docs//apis/WebhooksApi.md#updatewebhook) | Update a Webhook +*Account* | [**CreateAccountImage**](docs/\apis/AccountApi.md#createaccountimage) | Create an Account Image +*Account* | [**DeleteAccountImageById**](docs/\apis/AccountApi.md#deleteaccountimagebyid) | Delete Account Image By Id +*Account* | [**GetAccountSettingsImagesById**](docs/\apis/AccountApi.md#getaccountsettingsimagesbyid) | Get Account Image By ID +*Account* | [**ListAccountImages**](docs/\apis/AccountApi.md#listaccountimages) | List Account Images +*Account* | [**ListAccountSettings**](docs/\apis/AccountApi.md#listaccountsettings) | List Account Settings +*Account* | [**UpdateAccountSettingsImagesById**](docs/\apis/AccountApi.md#updateaccountsettingsimagesbyid) | Update Account Image By ID +*Addresses* | [**ParseAddress**](docs/\apis/AddressesApi.md#parseaddress) | Parse an address +*Addresses* | [**ValidateAddress**](docs/\apis/AddressesApi.md#validateaddress) | Validate An Address +*Batches* | [**AddToBatch**](docs/\apis/BatchesApi.md#addtobatch) | Add to a Batch +*Batches* | [**CreateBatch**](docs/\apis/BatchesApi.md#createbatch) | Create A Batch +*Batches* | [**DeleteBatch**](docs/\apis/BatchesApi.md#deletebatch) | Delete Batch By Id +*Batches* | [**GetBatchByExternalId**](docs/\apis/BatchesApi.md#getbatchbyexternalid) | Get Batch By External ID +*Batches* | [**GetBatchById**](docs/\apis/BatchesApi.md#getbatchbyid) | Get Batch By ID +*Batches* | [**ListBatchErrors**](docs/\apis/BatchesApi.md#listbatcherrors) | Get Batch Errors +*Batches* | [**ListBatches**](docs/\apis/BatchesApi.md#listbatches) | List Batches +*Batches* | [**ProcessBatch**](docs/\apis/BatchesApi.md#processbatch) | Process Batch ID Labels +*Batches* | [**RemoveFromBatch**](docs/\apis/BatchesApi.md#removefrombatch) | Remove From Batch +*Batches* | [**UpdateBatch**](docs/\apis/BatchesApi.md#updatebatch) | Update Batch By Id +*CarrierAccounts* | [**ConnectCarrier**](docs/\apis/CarrierAccountsApi.md#connectcarrier) | Connect a carrier account +*CarrierAccounts* | [**DisconnectCarrier**](docs/\apis/CarrierAccountsApi.md#disconnectcarrier) | Disconnect a carrier +*CarrierAccounts* | [**GetCarrierSettings**](docs/\apis/CarrierAccountsApi.md#getcarriersettings) | Get carrier settings +*CarrierAccounts* | [**UpdateCarrierSettings**](docs/\apis/CarrierAccountsApi.md#updatecarriersettings) | Update carrier settings +*Carriers* | [**AddFundsToCarrier**](docs/\apis/CarriersApi.md#addfundstocarrier) | Add Funds To Carrier +*Carriers* | [**DisconnectCarrierById**](docs/\apis/CarriersApi.md#disconnectcarrierbyid) | Disconnect Carrier by ID +*Carriers* | [**GetCarrierById**](docs/\apis/CarriersApi.md#getcarrierbyid) | Get Carrier By ID +*Carriers* | [**GetCarrierOptions**](docs/\apis/CarriersApi.md#getcarrieroptions) | Get Carrier Options +*Carriers* | [**ListCarrierPackageTypes**](docs/\apis/CarriersApi.md#listcarrierpackagetypes) | List Carrier Package Types +*Carriers* | [**ListCarrierServices**](docs/\apis/CarriersApi.md#listcarrierservices) | List Carrier Services +*Carriers* | [**ListCarriers**](docs/\apis/CarriersApi.md#listcarriers) | List Carriers +*Downloads* | [**DownloadFile**](docs/\apis/DownloadsApi.md#downloadfile) | Download File +*Insurance* | [**AddFundsToInsurance**](docs/\apis/InsuranceApi.md#addfundstoinsurance) | Add Funds To Insurance +*Insurance* | [**ConnectInsurer**](docs/\apis/InsuranceApi.md#connectinsurer) | Connect a Shipsurance Account +*Insurance* | [**DisconnectInsurer**](docs/\apis/InsuranceApi.md#disconnectinsurer) | Disconnect a Shipsurance Account +*Insurance* | [**GetInsuranceBalance**](docs/\apis/InsuranceApi.md#getinsurancebalance) | Get Insurance Funds Balance +*Labels* | [**CreateCombinedLabelDocument**](docs/\apis/LabelsApi.md#createcombinedlabeldocument) | Created Combined Label Document +*Labels* | [**CreateLabel**](docs/\apis/LabelsApi.md#createlabel) | Purchase Label +*Labels* | [**CreateLabelFromRate**](docs/\apis/LabelsApi.md#createlabelfromrate) | Purchase Label with Rate ID +*Labels* | [**CreateLabelFromShipment**](docs/\apis/LabelsApi.md#createlabelfromshipment) | Purchase Label with Shipment ID +*Labels* | [**CreateReturnLabel**](docs/\apis/LabelsApi.md#createreturnlabel) | Create a return label +*Labels* | [**GetLabelByExternalShipmentId**](docs/\apis/LabelsApi.md#getlabelbyexternalshipmentid) | Get Label By External Shipment ID +*Labels* | [**GetLabelById**](docs/\apis/LabelsApi.md#getlabelbyid) | Get Label By ID +*Labels* | [**GetTrackingLogFromLabel**](docs/\apis/LabelsApi.md#gettrackinglogfromlabel) | Get Label Tracking Information +*Labels* | [**ListLabels**](docs/\apis/LabelsApi.md#listlabels) | List labels +*Labels* | [**VoidLabel**](docs/\apis/LabelsApi.md#voidlabel) | Void a Label By ID +*Manifests* | [**CreateManifest**](docs/\apis/ManifestsApi.md#createmanifest) | Create Manifest +*Manifests* | [**GetManifestById**](docs/\apis/ManifestsApi.md#getmanifestbyid) | Get Manifest By Id +*Manifests* | [**GetManifestRequestById**](docs/\apis/ManifestsApi.md#getmanifestrequestbyid) | Get Manifest Request By Id +*Manifests* | [**ListManifests**](docs/\apis/ManifestsApi.md#listmanifests) | List Manifests +*PackagePickups* | [**DeleteScheduledPickup**](docs/\apis/PackagePickupsApi.md#deletescheduledpickup) | Delete a Scheduled Pickup +*PackagePickups* | [**GetPickupById**](docs/\apis/PackagePickupsApi.md#getpickupbyid) | Get Pickup By ID +*PackagePickups* | [**ListScheduledPickups**](docs/\apis/PackagePickupsApi.md#listscheduledpickups) | List Scheduled Pickups +*PackagePickups* | [**SchedulePickup**](docs/\apis/PackagePickupsApi.md#schedulepickup) | Schedule a Pickup +*PackageTypes* | [**CreatePackageType**](docs/\apis/PackageTypesApi.md#createpackagetype) | Create Custom Package Type +*PackageTypes* | [**DeletePackageType**](docs/\apis/PackageTypesApi.md#deletepackagetype) | Delete A Custom Package By ID +*PackageTypes* | [**GetPackageTypeById**](docs/\apis/PackageTypesApi.md#getpackagetypebyid) | Get Custom Package Type By ID +*PackageTypes* | [**ListPackageTypes**](docs/\apis/PackageTypesApi.md#listpackagetypes) | List Custom Package Types +*PackageTypes* | [**UpdatePackageType**](docs/\apis/PackageTypesApi.md#updatepackagetype) | Update Custom Package Type By ID +*Rates* | [**CalculateRates**](docs/\apis/RatesApi.md#calculaterates) | Get Shipping Rates +*Rates* | [**CompareBulkRates**](docs/\apis/RatesApi.md#comparebulkrates) | Get Bulk Rates +*Rates* | [**EstimateRates**](docs/\apis/RatesApi.md#estimaterates) | Estimate Rates +*Rates* | [**GetRateById**](docs/\apis/RatesApi.md#getratebyid) | Get Rate By ID +*ServicePoints* | [**ServicePointsGetById**](docs/\apis/ServicePointsApi.md#servicepointsgetbyid) | Get Service Point By ID +*ServicePoints* | [**ServicePointsList**](docs/\apis/ServicePointsApi.md#servicepointslist) | List Service Points +*Shipments* | [**CancelShipments**](docs/\apis/ShipmentsApi.md#cancelshipments) | Cancel a Shipment +*Shipments* | [**CreateShipments**](docs/\apis/ShipmentsApi.md#createshipments) | Create Shipments +*Shipments* | [**GetShipmentByExternalId**](docs/\apis/ShipmentsApi.md#getshipmentbyexternalid) | Get Shipment By External ID +*Shipments* | [**GetShipmentById**](docs/\apis/ShipmentsApi.md#getshipmentbyid) | Get Shipment By ID +*Shipments* | [**ListShipmentRates**](docs/\apis/ShipmentsApi.md#listshipmentrates) | Get Shipment Rates +*Shipments* | [**ListShipments**](docs/\apis/ShipmentsApi.md#listshipments) | List Shipments +*Shipments* | [**ParseShipment**](docs/\apis/ShipmentsApi.md#parseshipment) | Parse shipping info +*Shipments* | [**ShipmentsListTags**](docs/\apis/ShipmentsApi.md#shipmentslisttags) | Get Shipment Tags +*Shipments* | [**ShipmentsUpdateTags**](docs/\apis/ShipmentsApi.md#shipmentsupdatetags) | Update Shipments Tags +*Shipments* | [**TagShipment**](docs/\apis/ShipmentsApi.md#tagshipment) | Add Tag to Shipment +*Shipments* | [**UntagShipment**](docs/\apis/ShipmentsApi.md#untagshipment) | Remove Tag from Shipment +*Shipments* | [**UpdateShipment**](docs/\apis/ShipmentsApi.md#updateshipment) | Update Shipment By ID +*Tags* | [**CreateTag**](docs/\apis/TagsApi.md#createtag) | Create a New Tag +*Tags* | [**CreateTag_0**](docs/\apis/TagsApi.md#createtag_0) | Create a New Tag +*Tags* | [**DeleteTag**](docs/\apis/TagsApi.md#deletetag) | Delete Tag +*Tags* | [**ListTags**](docs/\apis/TagsApi.md#listtags) | Get Tags +*Tags* | [**RenameTag**](docs/\apis/TagsApi.md#renametag) | Update Tag Name +*Tokens* | [**TokensGetEphemeralToken**](docs/\apis/TokensApi.md#tokensgetephemeraltoken) | Get Ephemeral Token +*Tracking* | [**GetTrackingLog**](docs/\apis/TrackingApi.md#gettrackinglog) | Get Tracking Information +*Tracking* | [**StartTracking**](docs/\apis/TrackingApi.md#starttracking) | Start Tracking a Package +*Tracking* | [**StopTracking**](docs/\apis/TrackingApi.md#stoptracking) | Stop Tracking a Package +*Warehouses* | [**CreateWarehouse**](docs/\apis/WarehousesApi.md#createwarehouse) | Create Warehouse +*Warehouses* | [**DeleteWarehouse**](docs/\apis/WarehousesApi.md#deletewarehouse) | Delete Warehouse By ID +*Warehouses* | [**GetWarehouseById**](docs/\apis/WarehousesApi.md#getwarehousebyid) | Get Warehouse By Id +*Warehouses* | [**ListWarehouses**](docs/\apis/WarehousesApi.md#listwarehouses) | List Warehouses +*Warehouses* | [**UpdateWarehouse**](docs/\apis/WarehousesApi.md#updatewarehouse) | Update Warehouse By Id +*Warehouses* | [**UpdateWarehouseSettings**](docs/\apis/WarehousesApi.md#updatewarehousesettings) | Update Warehouse Settings +*Webhooks* | [**CreateWebhook**](docs/\apis/WebhooksApi.md#createwebhook) | Create a Webhook +*Webhooks* | [**DeleteWebhook**](docs/\apis/WebhooksApi.md#deletewebhook) | Delete Webhook By ID +*Webhooks* | [**GetWebhookById**](docs/\apis/WebhooksApi.md#getwebhookbyid) | Get Webhook By ID +*Webhooks* | [**ListWebhooks**](docs/\apis/WebhooksApi.md#listwebhooks) | List Webhooks +*Webhooks* | [**UpdateWebhook**](docs/\apis/WebhooksApi.md#updatewebhook) | Update a Webhook ## Legacy Methods diff --git a/ShipEngineSDK/Api/LabelsApi.cs b/ShipEngineSDK/Api/LabelsApi.cs index 6717e40..0d60993 100644 --- a/ShipEngineSDK/Api/LabelsApi.cs +++ b/ShipEngineSDK/Api/LabelsApi.cs @@ -24,6 +24,27 @@ namespace ShipEngineSDK; /// public partial interface IShipEngine { + /// + /// Created Combined Label Document Download a combined label file + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateCombinedLabelDocumentResponseBodyYaml) + Task CreateCombinedLabelDocument(CreateCombinedLabelDocumentRequestBody createCombinedLabelDocumentRequestBody, CancellationToken cancellationToken = default); + + /// + /// Created Combined Label Document Download a combined label file + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateCombinedLabelDocumentResponseBodyYaml) + Task CreateCombinedLabelDocument(HttpClient methodClient, CreateCombinedLabelDocumentRequestBody createCombinedLabelDocumentRequestBody, CancellationToken cancellationToken = default); + /// /// Purchase Label Purchase and print a label for shipment /// @@ -256,6 +277,48 @@ public partial interface IShipEngine /// public partial class ShipEngine { + /// + /// Created Combined Label Document Download a combined label file + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateCombinedLabelDocumentResponseBodyYaml) + public Task CreateCombinedLabelDocument(CreateCombinedLabelDocumentRequestBody createCombinedLabelDocumentRequestBody, CancellationToken cancellationToken = default) + { + return CreateCombinedLabelDocument(_client, createCombinedLabelDocumentRequestBody, cancellationToken); + } + + /// + /// Created Combined Label Document Download a combined label file + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateCombinedLabelDocumentResponseBodyYaml) + public async Task CreateCombinedLabelDocument(HttpClient methodClient, CreateCombinedLabelDocumentRequestBody createCombinedLabelDocumentRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'createCombinedLabelDocumentRequestBody' is set + if (createCombinedLabelDocumentRequestBody == null) + { + throw new ArgumentNullException(nameof(createCombinedLabelDocumentRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/documents/combined_labels"); + + requestOptions.Data = JsonSerializer.Serialize(createCombinedLabelDocumentRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "LabelsApi.CreateCombinedLabelDocument"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + /// /// Purchase Label Purchase and print a label for shipment /// diff --git a/ShipEngineSDK/Api/TagsApi.cs b/ShipEngineSDK/Api/TagsApi.cs index 9403158..b49133a 100644 --- a/ShipEngineSDK/Api/TagsApi.cs +++ b/ShipEngineSDK/Api/TagsApi.cs @@ -25,17 +25,38 @@ namespace ShipEngineSDK; public partial interface IShipEngine { /// - /// Create a New Tag Create a new Tag for customizing how you track your shipments + /// Create a New Tag Create a new tag for customizing how you track your shipments. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateTagResponseBody) + Task CreateTag(CreateTagRequestBody createTagRequestBody, CancellationToken cancellationToken = default); + + /// + /// Create a New Tag Create a new tag for customizing how you track your shipments. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateTagResponseBody) + Task CreateTag(HttpClient methodClient, CreateTagRequestBody createTagRequestBody, CancellationToken cancellationToken = default); + + /// + /// Create a New Tag Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead) /// /// Thrown when required argument is null /// Thrown when fails to make API call /// /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateTagResponseBody) - Task CreateTag(string tagName, CancellationToken cancellationToken = default); + Task CreateTag_0(string tagName, CancellationToken cancellationToken = default); /// - /// Create a New Tag Create a new Tag for customizing how you track your shipments + /// Create a New Tag Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead) /// /// Thrown when required argument is null /// Thrown when fails to make API call @@ -43,7 +64,7 @@ public partial interface IShipEngine /// /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateTagResponseBody) - Task CreateTag(HttpClient methodClient, string tagName, CancellationToken cancellationToken = default); + Task CreateTag_0(HttpClient methodClient, string tagName, CancellationToken cancellationToken = default); /// /// Delete Tag Delete a tag that is no longer needed @@ -116,20 +137,62 @@ public partial interface IShipEngine public partial class ShipEngine { /// - /// Create a New Tag Create a new Tag for customizing how you track your shipments + /// Create a New Tag Create a new tag for customizing how you track your shipments. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateTagResponseBody) + public Task CreateTag(CreateTagRequestBody createTagRequestBody, CancellationToken cancellationToken = default) + { + return CreateTag(_client, createTagRequestBody, cancellationToken); + } + + /// + /// Create a New Tag Create a new tag for customizing how you track your shipments. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateTagResponseBody) + public async Task CreateTag(HttpClient methodClient, CreateTagRequestBody createTagRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'createTagRequestBody' is set + if (createTagRequestBody == null) + { + throw new ArgumentNullException(nameof(createTagRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/tags"); + + requestOptions.Data = JsonSerializer.Serialize(createTagRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "TagsApi.CreateTag"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Create a New Tag Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead) /// /// Thrown when required argument is null /// Thrown when fails to make API call /// /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateTagResponseBody) - public Task CreateTag(string tagName, CancellationToken cancellationToken = default) + public Task CreateTag_0(string tagName, CancellationToken cancellationToken = default) { - return CreateTag(_client, tagName, cancellationToken); + return CreateTag_0(_client, tagName, cancellationToken); } /// - /// Create a New Tag Create a new Tag for customizing how you track your shipments + /// Create a New Tag Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead) /// /// Thrown when required argument is null /// Thrown when fails to make API call @@ -137,7 +200,7 @@ public Task CreateTag(string tagName, CancellationToken c /// /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateTagResponseBody) - public async Task CreateTag(HttpClient methodClient, string tagName, CancellationToken cancellationToken = default) + public async Task CreateTag_0(HttpClient methodClient, string tagName, CancellationToken cancellationToken = default) { // verify the required parameter 'tagName' is set if (tagName == null) @@ -150,7 +213,7 @@ public async Task CreateTag(HttpClient methodClient, stri requestOptions.PathParameters.Add("tag_name", ClientUtils.ParameterToString(tagName)); // path parameter - requestOptions.Operation = "TagsApi.CreateTag"; + requestOptions.Operation = "TagsApi.CreateTag_0"; var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); diff --git a/ShipEngineSDK/Model/CreateCombinedLabelDocumentRequestBody.cs b/ShipEngineSDK/Model/CreateCombinedLabelDocumentRequestBody.cs new file mode 100644 index 0000000..6ab12b2 --- /dev/null +++ b/ShipEngineSDK/Model/CreateCombinedLabelDocumentRequestBody.cs @@ -0,0 +1,185 @@ +// +// DO NOT MODIFY THIS FILE + +// Changes can be made in a corresponding partial file, or by changing +// the template in /generation/templates and generating the class again. + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Runtime.Serialization; +using System.Text; +using System.Text.Json; +using System.Text.Json.Serialization; +using System.Text.Json.Serialization.Metadata; +using System.Text.RegularExpressions; + +namespace ShipEngineSDK.Model; + +/// +/// A create combined label document request body +/// +public partial class CreateCombinedLabelDocumentRequestBody +{ + /// + /// The download type for the combined label document; note that currently only `\"inline\"` is supported. + /// + /// The download type for the combined label document; note that currently only `\"inline\"` is supported. + [JsonConverter(typeof(LabelDownloadTypeEnumJsonConverter))] + public class LabelDownloadTypeEnum + { + private readonly string _value; + + /// + /// Create a new instance of LabelDownloadTypeEnum with a predefined value. + /// + internal LabelDownloadTypeEnum() + { + _value = "inline"; + } + + /// + /// Create a new instance of LabelDownloadTypeEnum with a custom value. + /// + /// The value of the LabelDownloadTypeEnum + /// + /// You can send a custom value to the API using this constructor, but the API most likely won't know what to do with it. + /// You should use the predefined values returned by the static properties of this class unless you know that the value is value. + /// + public LabelDownloadTypeEnum(string value) + { + _value = value; + } + + /// + /// Enum Inline for value: inline + /// + public static LabelDownloadTypeEnum Inline { get; } = new("inline"); + + + /// + /// Get a string representation of the current value + /// + public override string ToString() => _value; + } + + internal class LabelDownloadTypeEnumJsonConverter : JsonConverter + { + public override LabelDownloadTypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new LabelDownloadTypeEnum(reader.GetString()!) : null; + + public override void Write(Utf8JsonWriter writer, LabelDownloadTypeEnum value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(LabelDownloadTypeEnum); + } + + /// + /// The file format for the combined label document; note that currently only `\"pdf\"` is supported. + /// + /// The file format for the combined label document; note that currently only `\"pdf\"` is supported. + [JsonConverter(typeof(LabelFormatEnumJsonConverter))] + public class LabelFormatEnum + { + private readonly string _value; + + /// + /// Create a new instance of LabelFormatEnum with a predefined value. + /// + internal LabelFormatEnum() + { + _value = "pdf"; + } + + /// + /// Create a new instance of LabelFormatEnum with a custom value. + /// + /// The value of the LabelFormatEnum + /// + /// You can send a custom value to the API using this constructor, but the API most likely won't know what to do with it. + /// You should use the predefined values returned by the static properties of this class unless you know that the value is value. + /// + public LabelFormatEnum(string value) + { + _value = value; + } + + /// + /// Enum Pdf for value: pdf + /// + public static LabelFormatEnum Pdf { get; } = new("pdf"); + + + /// + /// Get a string representation of the current value + /// + public override string ToString() => _value; + } + + internal class LabelFormatEnumJsonConverter : JsonConverter + { + public override LabelFormatEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new LabelFormatEnum(reader.GetString()!) : null; + + public override void Write(Utf8JsonWriter writer, LabelFormatEnum value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(LabelFormatEnum); + } + + + /// + /// The download type for the combined label document; note that currently only `\"inline\"` is supported. + /// + /// The download type for the combined label document; note that currently only `\"inline\"` is supported. + [JsonPropertyName("label_download_type"), JsonPropertyOrder(1)] + public LabelDownloadTypeEnum? LabelDownloadType { get; set; } + + /// + /// The file format for the combined label document; note that currently only `\"pdf\"` is supported. + /// + /// The file format for the combined label document; note that currently only `\"pdf\"` is supported. + [JsonPropertyName("label_format"), JsonPropertyOrder(2)] + public LabelFormatEnum? LabelFormat { get; set; } + + /// + /// The list of up to 30 label ids to include in the combined label document. Note that to avoid response size limits, you should only expect to be able to combine 30 single page labels similar in size to that of USPS labels. + /// + /// The list of up to 30 label ids to include in the combined label document. Note that to avoid response size limits, you should only expect to be able to combine 30 single page labels similar in size to that of USPS labels. + [JsonPropertyName("label_ids"), JsonPropertyOrder(3)] + public List? LabelIds { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateCombinedLabelDocumentRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson(JsonSerializerOptions options) + { + return JsonSerializer.Serialize(this, options); + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/CreateCombinedLabelDocumentResponseBodyYaml.cs b/ShipEngineSDK/Model/CreateCombinedLabelDocumentResponseBodyYaml.cs new file mode 100644 index 0000000..17df97c --- /dev/null +++ b/ShipEngineSDK/Model/CreateCombinedLabelDocumentResponseBodyYaml.cs @@ -0,0 +1,64 @@ +// +// DO NOT MODIFY THIS FILE + +// Changes can be made in a corresponding partial file, or by changing +// the template in /generation/templates and generating the class again. + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Runtime.Serialization; +using System.Text; +using System.Text.Json; +using System.Text.Json.Serialization; +using System.Text.Json.Serialization.Metadata; +using System.Text.RegularExpressions; + +namespace ShipEngineSDK.Model; + +/// +/// A create combined label document response body +/// +public partial class CreateCombinedLabelDocumentResponseBodyYaml +{ + + /// + /// The download for the combined label document + /// + /// The download for the combined label document + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateCombinedLabelDocumentResponseBodyYaml {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson(JsonSerializerOptions options) + { + return JsonSerializer.Serialize(this, options); + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index 2aacd93..3aa2f5a 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -82,6 +82,16 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("confirmation"), JsonInclude] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -99,7 +109,7 @@ public partial class CreateLabelFromRateResponseBody /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] public DisplayScheme? DisplayScheme { get; set; } /// @@ -146,7 +156,7 @@ public partial class CreateLabelFromRateResponseBody /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. - [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(13)] public bool? IsReturnLabel { get; set; } /// @@ -161,14 +171,14 @@ public partial class CreateLabelFromRateResponseBody /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), JsonWriteOnly] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(15), JsonWriteOnly] public LabelDownloadType? LabelDownloadType { get; set; } /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. - [JsonPropertyName("label_format"), JsonPropertyOrder(15)] + [JsonPropertyName("label_format"), JsonPropertyOrder(16)] public LabelFormat? LabelFormat { get; set; } /// @@ -191,14 +201,14 @@ public partial class CreateLabelFromRateResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(18)] public string? LabelImageId { get; set; } /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. - [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] + [JsonPropertyName("label_layout"), JsonPropertyOrder(19)] public LabelLayout? LabelLayout { get; set; } /// @@ -208,7 +218,7 @@ public partial class CreateLabelFromRateResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -268,7 +278,7 @@ public partial class CreateLabelFromRateResponseBody /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. - [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(26)] public string? RmaNumber { get; set; } /// @@ -301,7 +311,7 @@ public partial class CreateLabelFromRateResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(29), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -340,7 +350,7 @@ public partial class CreateLabelFromRateResponseBody /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. - [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(33), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -392,7 +402,7 @@ public partial class CreateLabelFromRateResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -433,6 +443,7 @@ public override string ToString() sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index d4f799f..330d913 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -82,6 +82,16 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("confirmation"), JsonInclude] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -99,7 +109,7 @@ public partial class CreateLabelFromShipmentResponseBody /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] public DisplayScheme? DisplayScheme { get; set; } /// @@ -146,7 +156,7 @@ public partial class CreateLabelFromShipmentResponseBody /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. - [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(13)] public bool? IsReturnLabel { get; set; } /// @@ -161,14 +171,14 @@ public partial class CreateLabelFromShipmentResponseBody /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), JsonWriteOnly] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(15), JsonWriteOnly] public LabelDownloadType? LabelDownloadType { get; set; } /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. - [JsonPropertyName("label_format"), JsonPropertyOrder(15)] + [JsonPropertyName("label_format"), JsonPropertyOrder(16)] public LabelFormat? LabelFormat { get; set; } /// @@ -191,14 +201,14 @@ public partial class CreateLabelFromShipmentResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(18)] public string? LabelImageId { get; set; } /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. - [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] + [JsonPropertyName("label_layout"), JsonPropertyOrder(19)] public LabelLayout? LabelLayout { get; set; } /// @@ -208,7 +218,7 @@ public partial class CreateLabelFromShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -268,7 +278,7 @@ public partial class CreateLabelFromShipmentResponseBody /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. - [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(26)] public string? RmaNumber { get; set; } /// @@ -301,7 +311,7 @@ public partial class CreateLabelFromShipmentResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(29), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -340,7 +350,7 @@ public partial class CreateLabelFromShipmentResponseBody /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. - [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(33), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -392,7 +402,7 @@ public partial class CreateLabelFromShipmentResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -433,6 +443,7 @@ public override string ToString() sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index b55e0f6..7da323d 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -289,6 +289,16 @@ public partial class CreateLabelResponseBody [JsonPropertyName("alternative_identifiers"), JsonInclude] public List? AlternativeIdentifiers { get; set; } + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("confirmation"), JsonInclude] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. /// @@ -312,7 +322,7 @@ public partial class CreateLabelResponseBody /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(28), JsonWriteOnly] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(29), JsonWriteOnly] public LabelDownloadType? LabelDownloadType { get; set; } /// @@ -322,7 +332,7 @@ public partial class CreateLabelResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonPropertyOrder(29)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(30)] public required string LabelImageId { get; set; } /// @@ -332,7 +342,7 @@ public partial class CreateLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(30), JsonWriteOnly] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(31), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -369,21 +379,21 @@ public partial class CreateLabelResponseBody /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. - [JsonPropertyName("rma_number"), JsonPropertyOrder(34)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(35)] public required string RmaNumber { get; set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(35), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(36), JsonWriteOnly] public Shipment? Shipment { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. - [JsonPropertyName("test_label"), JsonPropertyOrder(36), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(37), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -402,7 +412,7 @@ public partial class CreateLabelResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(39), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -453,6 +463,7 @@ public override string ToString() sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); sb.Append(" Voided: ").Append(Voided).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index c969121..05f46a1 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -82,6 +82,16 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("confirmation"), JsonInclude] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -99,7 +109,7 @@ public partial class CreateReturnLabelResponseBody /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] public DisplayScheme? DisplayScheme { get; set; } /// @@ -146,7 +156,7 @@ public partial class CreateReturnLabelResponseBody /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. - [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(13)] public bool? IsReturnLabel { get; set; } /// @@ -161,14 +171,14 @@ public partial class CreateReturnLabelResponseBody /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), JsonWriteOnly] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(15), JsonWriteOnly] public LabelDownloadType? LabelDownloadType { get; set; } /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. - [JsonPropertyName("label_format"), JsonPropertyOrder(15)] + [JsonPropertyName("label_format"), JsonPropertyOrder(16)] public LabelFormat? LabelFormat { get; set; } /// @@ -191,14 +201,14 @@ public partial class CreateReturnLabelResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(18)] public string? LabelImageId { get; set; } /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. - [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] + [JsonPropertyName("label_layout"), JsonPropertyOrder(19)] public LabelLayout? LabelLayout { get; set; } /// @@ -208,7 +218,7 @@ public partial class CreateReturnLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -268,7 +278,7 @@ public partial class CreateReturnLabelResponseBody /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. - [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(26)] public string? RmaNumber { get; set; } /// @@ -301,7 +311,7 @@ public partial class CreateReturnLabelResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(29), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -340,7 +350,7 @@ public partial class CreateReturnLabelResponseBody /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. - [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(33), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -392,7 +402,7 @@ public partial class CreateReturnLabelResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -433,6 +443,7 @@ public override string ToString() sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateTagRequestBody.cs b/ShipEngineSDK/Model/CreateTagRequestBody.cs new file mode 100644 index 0000000..e50152a --- /dev/null +++ b/ShipEngineSDK/Model/CreateTagRequestBody.cs @@ -0,0 +1,75 @@ +// +// DO NOT MODIFY THIS FILE + +// Changes can be made in a corresponding partial file, or by changing +// the template in /generation/templates and generating the class again. + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Runtime.Serialization; +using System.Text; +using System.Text.Json; +using System.Text.Json.Serialization; +using System.Text.Json.Serialization.Metadata; +using System.Text.RegularExpressions; + +namespace ShipEngineSDK.Model; + +/// +/// A create tag request body +/// +public partial class CreateTagRequestBody +{ + + /// + /// The tag name. + /// + /// The tag name. + /// + /// Fragile + /// + [JsonPropertyName("name"), JsonPropertyOrder(1)] + public required string Name { get; set; } + + /// + /// A hex-coded string identifying the color of the tag. + /// + /// A hex-coded string identifying the color of the tag. + /// + /// #FF0000 + /// + [JsonPropertyName("color"), JsonPropertyOrder(2)] + public string? Color { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateTagRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Color: ").Append(Color).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson(JsonSerializerOptions options) + { + return JsonSerializer.Serialize(this, options); + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/CreateTagResponseBody.cs b/ShipEngineSDK/Model/CreateTagResponseBody.cs index be7e513..683ae8a 100644 --- a/ShipEngineSDK/Model/CreateTagResponseBody.cs +++ b/ShipEngineSDK/Model/CreateTagResponseBody.cs @@ -36,6 +36,29 @@ public partial class CreateTagResponseBody [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } + /// + /// A hex-coded string identifying the color of the tag. + /// + /// A hex-coded string identifying the color of the tag. + /// + /// #FF0000 + /// + [JsonPropertyName("color"), JsonPropertyOrder(2)] + public string? Color { get; set; } + + /// + /// An integer uniquely identifying a tag. + /// + /// An integer uniquely identifying a tag. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// 8712 + /// + [JsonPropertyName("tag_id"), JsonInclude] + public int? TagId { get; set; } + /// /// Returns the string presentation of the object @@ -47,6 +70,8 @@ public override string ToString() sb.Append("class CreateTagResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Color: ").Append(Color).Append("\n"); + sb.Append(" TagId: ").Append(TagId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ErrorType.cs b/ShipEngineSDK/Model/ErrorType.cs index 07ea4e8..2c2b630 100644 --- a/ShipEngineSDK/Model/ErrorType.cs +++ b/ShipEngineSDK/Model/ErrorType.cs @@ -86,18 +86,6 @@ public ErrorType(string value) public static ErrorType Integrations { get; } = new("integrations"); - /// - /// Enum Wallet for value: wallet - /// - public static ErrorType Wallet { get; } = new("wallet"); - - - /// - /// Enum FundingSources for value: funding_sources - /// - public static ErrorType FundingSources { get; } = new("funding_sources"); - - /// /// Get a string representation of the current value /// diff --git a/ShipEngineSDK/Model/EstimatedImportCharges.cs b/ShipEngineSDK/Model/EstimatedImportCharges.cs new file mode 100644 index 0000000..50cd2b6 --- /dev/null +++ b/ShipEngineSDK/Model/EstimatedImportCharges.cs @@ -0,0 +1,69 @@ +// +// DO NOT MODIFY THIS FILE + +// Changes can be made in a corresponding partial file, or by changing +// the template in /generation/templates and generating the class again. + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Runtime.Serialization; +using System.Text; +using System.Text.Json; +using System.Text.Json.Serialization; +using System.Text.Json.Serialization.Metadata; +using System.Text.RegularExpressions; + +namespace ShipEngineSDK.Model; + +/// +/// Estimated import charges for commercial invoices for international shipments. +/// +public partial class EstimatedImportCharges +{ + + /// + /// Estimated import duties. + /// + /// Estimated import duties. + [JsonPropertyName("duties"), JsonPropertyOrder(1)] + public MonetaryValue? Duties { get; set; } + + /// + /// Estimated import taxes. + /// + /// Estimated import taxes. + [JsonPropertyName("taxes"), JsonPropertyOrder(2)] + public MonetaryValue? Taxes { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class EstimatedImportCharges {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Duties: ").Append(Duties).Append("\n"); + sb.Append(" Taxes: ").Append(Taxes).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson(JsonSerializerOptions options) + { + return JsonSerializer.Serialize(this, options); + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index 452ec01..297b238 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -82,6 +82,16 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("confirmation"), JsonInclude] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -99,7 +109,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] public DisplayScheme? DisplayScheme { get; set; } /// @@ -146,7 +156,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. - [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(13)] public bool? IsReturnLabel { get; set; } /// @@ -161,14 +171,14 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), JsonWriteOnly] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(15), JsonWriteOnly] public LabelDownloadType? LabelDownloadType { get; set; } /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. - [JsonPropertyName("label_format"), JsonPropertyOrder(15)] + [JsonPropertyName("label_format"), JsonPropertyOrder(16)] public LabelFormat? LabelFormat { get; set; } /// @@ -191,14 +201,14 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(18)] public string? LabelImageId { get; set; } /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. - [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] + [JsonPropertyName("label_layout"), JsonPropertyOrder(19)] public LabelLayout? LabelLayout { get; set; } /// @@ -208,7 +218,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -268,7 +278,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. - [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(26)] public string? RmaNumber { get; set; } /// @@ -301,7 +311,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(29), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -340,7 +350,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. - [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(33), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -392,7 +402,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -433,6 +443,7 @@ public override string ToString() sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index e5b14f3..e63c24d 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -82,6 +82,16 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("confirmation"), JsonInclude] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -99,7 +109,7 @@ public partial class GetLabelByIdResponseBody /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] public DisplayScheme? DisplayScheme { get; set; } /// @@ -146,7 +156,7 @@ public partial class GetLabelByIdResponseBody /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. - [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(13)] public bool? IsReturnLabel { get; set; } /// @@ -161,14 +171,14 @@ public partial class GetLabelByIdResponseBody /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), JsonWriteOnly] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(15), JsonWriteOnly] public LabelDownloadType? LabelDownloadType { get; set; } /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. - [JsonPropertyName("label_format"), JsonPropertyOrder(15)] + [JsonPropertyName("label_format"), JsonPropertyOrder(16)] public LabelFormat? LabelFormat { get; set; } /// @@ -191,14 +201,14 @@ public partial class GetLabelByIdResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(18)] public string? LabelImageId { get; set; } /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. - [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] + [JsonPropertyName("label_layout"), JsonPropertyOrder(19)] public LabelLayout? LabelLayout { get; set; } /// @@ -208,7 +218,7 @@ public partial class GetLabelByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -268,7 +278,7 @@ public partial class GetLabelByIdResponseBody /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. - [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(26)] public string? RmaNumber { get; set; } /// @@ -301,7 +311,7 @@ public partial class GetLabelByIdResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(29), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -340,7 +350,7 @@ public partial class GetLabelByIdResponseBody /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. - [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(33), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -392,7 +402,7 @@ public partial class GetLabelByIdResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -433,6 +443,7 @@ public override string ToString() sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); diff --git a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs index 30c9422..90a9663 100644 --- a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs +++ b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs @@ -33,32 +33,39 @@ public partial class InvoiceAdditionalDetails [JsonPropertyName("discount"), JsonPropertyOrder(1)] public MonetaryValue? Discount { get; set; } + /// + /// Estimated import charges for commercial invoices for international shipments. + /// + /// Estimated import charges for commercial invoices for international shipments. + [JsonPropertyName("estimated_import_charges"), JsonPropertyOrder(2)] + public EstimatedImportCharges? EstimatedImportCharges { get; set; } + /// /// Freight Charge for shipment. /// /// Freight Charge for shipment. - [JsonPropertyName("freight_charge"), JsonPropertyOrder(2)] + [JsonPropertyName("freight_charge"), JsonPropertyOrder(3)] public MonetaryValue? FreightCharge { get; set; } /// /// Insurance Charge for shipment. /// /// Insurance Charge for shipment. - [JsonPropertyName("insurance_charge"), JsonPropertyOrder(3)] + [JsonPropertyName("insurance_charge"), JsonPropertyOrder(4)] public MonetaryValue? InsuranceCharge { get; set; } /// /// Other charge for shipment. /// /// Other charge for shipment. - [JsonPropertyName("other_charge"), JsonPropertyOrder(4)] + [JsonPropertyName("other_charge"), JsonPropertyOrder(5)] public MonetaryValue? OtherCharge { get; set; } /// /// Description for the other charge (if provided). /// /// Description for the other charge (if provided). - [JsonPropertyName("other_charge_description"), JsonPropertyOrder(5)] + [JsonPropertyName("other_charge_description"), JsonPropertyOrder(6)] public string? OtherChargeDescription { get; set; } @@ -72,6 +79,7 @@ public override string ToString() sb.Append("class InvoiceAdditionalDetails {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Discount: ").Append(Discount).Append("\n"); + sb.Append(" EstimatedImportCharges: ").Append(EstimatedImportCharges).Append("\n"); sb.Append(" FreightCharge: ").Append(FreightCharge).Append("\n"); sb.Append(" InsuranceCharge: ").Append(InsuranceCharge).Append("\n"); sb.Append(" OtherCharge: ").Append(OtherCharge).Append("\n"); diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index 5e37ea9..669ef17 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -82,6 +82,16 @@ public partial class Label [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("confirmation"), JsonInclude] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -99,7 +109,7 @@ public partial class Label /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] public DisplayScheme? DisplayScheme { get; set; } /// @@ -146,7 +156,7 @@ public partial class Label /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. - [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(13)] public bool? IsReturnLabel { get; set; } /// @@ -161,14 +171,14 @@ public partial class Label /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), JsonWriteOnly] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(15), JsonWriteOnly] public LabelDownloadType? LabelDownloadType { get; set; } /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. /// /// The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. - [JsonPropertyName("label_format"), JsonPropertyOrder(15)] + [JsonPropertyName("label_format"), JsonPropertyOrder(16)] public LabelFormat? LabelFormat { get; set; } /// @@ -191,14 +201,14 @@ public partial class Label /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(18)] public string? LabelImageId { get; set; } /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. /// /// The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. - [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] + [JsonPropertyName("label_layout"), JsonPropertyOrder(19)] public LabelLayout? LabelLayout { get; set; } /// @@ -208,7 +218,7 @@ public partial class Label /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -268,7 +278,7 @@ public partial class Label /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. - [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(26)] public string? RmaNumber { get; set; } /// @@ -301,7 +311,7 @@ public partial class Label /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(29), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -340,7 +350,7 @@ public partial class Label /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. - [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(33), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -392,7 +402,7 @@ public partial class Label /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -433,6 +443,7 @@ public override string ToString() sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index b9c2885..56063e6 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -291,6 +291,13 @@ public class ListLabelsResponseBodyItem [JsonPropertyName("tracking_status"), JsonInclude] public TrackingStatus? TrackingStatus { get; set; } + /// + /// The type of delivery confirmation that is required for this shipment. + /// + /// The type of delivery confirmation that is required for this shipment. + [JsonPropertyName("confirmation"), JsonInclude] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// Gets or Sets LabelDownload /// diff --git a/ShipEngineSDK/Model/RateRequestBody.cs b/ShipEngineSDK/Model/RateRequestBody.cs index 64142be..c2dc3f5 100644 --- a/ShipEngineSDK/Model/RateRequestBody.cs +++ b/ShipEngineSDK/Model/RateRequestBody.cs @@ -25,6 +25,72 @@ namespace ShipEngineSDK.Model; /// public partial class RateRequestBody { + /// + /// Indicates what type of rating to perform + /// + /// Indicates what type of rating to perform + [JsonConverter(typeof(RateTypeEnumJsonConverter))] + public class RateTypeEnum + { + private readonly string _value; + + /// + /// Create a new instance of RateTypeEnum with a predefined value. + /// + internal RateTypeEnum() + { + _value = "check"; + } + + /// + /// Create a new instance of RateTypeEnum with a custom value. + /// + /// The value of the RateTypeEnum + /// + /// You can send a custom value to the API using this constructor, but the API most likely won't know what to do with it. + /// You should use the predefined values returned by the static properties of this class unless you know that the value is value. + /// + public RateTypeEnum(string value) + { + _value = value; + } + + /// + /// Enum Check for value: check + /// + public static RateTypeEnum Check { get; } = new("check"); + + + /// + /// Enum Shipment for value: shipment + /// + public static RateTypeEnum Shipment { get; } = new("shipment"); + + + /// + /// Enum Quick for value: quick + /// + public static RateTypeEnum Quick { get; } = new("quick"); + + + /// + /// Get a string representation of the current value + /// + public override string ToString() => _value; + } + + internal class RateTypeEnumJsonConverter : JsonConverter + { + public override RateTypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new RateTypeEnum(reader.GetString()!) : null; + + public override void Write(Utf8JsonWriter writer, RateTypeEnum value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(RateTypeEnum); + } + /// /// Array of carrier ids to get rates for @@ -60,10 +126,17 @@ public partial class RateRequestBody [JsonPropertyName("preferred_currency"), JsonPropertyOrder(5)] public string? PreferredCurrency { get; set; } + /// + /// Indicates what type of rating to perform + /// + /// Indicates what type of rating to perform + [JsonPropertyName("rate_type"), JsonPropertyOrder(6)] + public RateTypeEnum? RateType { get; set; } + /// /// Gets or Sets ServiceCodes /// - [JsonPropertyName("service_codes"), JsonPropertyOrder(6)] + [JsonPropertyName("service_codes"), JsonPropertyOrder(7)] public List? ServiceCodes { get; set; } @@ -81,6 +154,7 @@ public override string ToString() sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); sb.Append(" PackageTypes: ").Append(PackageTypes).Append("\n"); sb.Append(" PreferredCurrency: ").Append(PreferredCurrency).Append("\n"); + sb.Append(" RateType: ").Append(RateType).Append("\n"); sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/Tag.cs b/ShipEngineSDK/Model/Tag.cs index 2a551bd..88a2958 100644 --- a/ShipEngineSDK/Model/Tag.cs +++ b/ShipEngineSDK/Model/Tag.cs @@ -36,6 +36,29 @@ public partial class Tag [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } + /// + /// A hex-coded string identifying the color of the tag. + /// + /// A hex-coded string identifying the color of the tag. + /// + /// #FF0000 + /// + [JsonPropertyName("color"), JsonPropertyOrder(2)] + public string? Color { get; set; } + + /// + /// An integer uniquely identifying a tag. + /// + /// An integer uniquely identifying a tag. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// 8712 + /// + [JsonPropertyName("tag_id"), JsonInclude] + public int? TagId { get; set; } + /// /// Returns the string presentation of the object @@ -47,6 +70,8 @@ public override string ToString() sb.Append("class Tag {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Color: ").Append(Color).Append("\n"); + sb.Append(" TagId: ").Append(TagId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/docs/apis/AccountApi.md b/docs/apis/AccountApi.md index 5cecd50..34b2922 100644 --- a/docs/apis/AccountApi.md +++ b/docs/apis/AccountApi.md @@ -58,7 +58,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createAccountSettingsImageRequestBody** | [**CreateAccountSettingsImageRequestBody**](../../docs//models/CreateAccountSettingsImageRequestBody.md) | | | +| **createAccountSettingsImageRequestBody** | [**CreateAccountSettingsImageRequestBody**](../../docs/\models/CreateAccountSettingsImageRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -335,7 +335,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateAccountSettingsImageRequestBody** | [**UpdateAccountSettingsImageRequestBody**](../../docs//models/UpdateAccountSettingsImageRequestBody.md) | | | +| **updateAccountSettingsImageRequestBody** | [**UpdateAccountSettingsImageRequestBody**](../../docs/\models/UpdateAccountSettingsImageRequestBody.md) | | | | **labelImageId** | **string** | Label Image Id | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/AddressesApi.md b/docs/apis/AddressesApi.md index 0a17606..72733a2 100644 --- a/docs/apis/AddressesApi.md +++ b/docs/apis/AddressesApi.md @@ -54,7 +54,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **parseAddressRequestBody** | [**ParseAddressRequestBody**](../../docs//models/ParseAddressRequestBody.md) | The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines. | | +| **parseAddressRequestBody** | [**ParseAddressRequestBody**](../../docs/\models/ParseAddressRequestBody.md) | The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines. | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -110,7 +110,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **addressToValidate** | [**List<AddressToValidate>**](../../docs//models/AddressToValidate.md) | | | +| **addressToValidate** | [**List<AddressToValidate>**](../../docs/\models/AddressToValidate.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/BatchesApi.md b/docs/apis/BatchesApi.md index 25232c3..0903ba8 100644 --- a/docs/apis/BatchesApi.md +++ b/docs/apis/BatchesApi.md @@ -63,7 +63,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **addToBatchRequestBody** | [**AddToBatchRequestBody**](../../docs//models/AddToBatchRequestBody.md) | | | +| **addToBatchRequestBody** | [**AddToBatchRequestBody**](../../docs/\models/AddToBatchRequestBody.md) | | | | **batchId** | **string** | Batch ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -120,7 +120,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createBatchRequest** | [**CreateBatchRequest**](../../docs//models/CreateBatchRequest.md) | | | +| **createBatchRequest** | [**CreateBatchRequest**](../../docs/\models/CreateBatchRequest.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -471,7 +471,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **processBatchRequestBody** | [**ProcessBatchRequestBody**](../../docs//models/ProcessBatchRequestBody.md) | | | +| **processBatchRequestBody** | [**ProcessBatchRequestBody**](../../docs/\models/ProcessBatchRequestBody.md) | | | | **batchId** | **string** | Batch ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -529,7 +529,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **removeFromBatchRequestBody** | [**RemoveFromBatchRequestBody**](../../docs//models/RemoveFromBatchRequestBody.md) | | | +| **removeFromBatchRequestBody** | [**RemoveFromBatchRequestBody**](../../docs/\models/RemoveFromBatchRequestBody.md) | | | | **batchId** | **string** | Batch ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/CarrierAccountsApi.md b/docs/apis/CarrierAccountsApi.md index 1f2b1a7..bff3dba 100644 --- a/docs/apis/CarrierAccountsApi.md +++ b/docs/apis/CarrierAccountsApi.md @@ -58,7 +58,7 @@ namespace Example |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | | **carrierName** | **CarrierName** | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | | -| **connectCarrierRequestBody** | [**ConnectCarrierRequestBody**](../../docs//models/ConnectCarrierRequestBody.md) | | | +| **connectCarrierRequestBody** | [**ConnectCarrierRequestBody**](../../docs/\models/ConnectCarrierRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -233,7 +233,7 @@ namespace Example |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | | **carrierName** | **CarrierNameWithSettings** | The carrier name, such as `ups`, `fedex`, or `dhl_express`. | | -| **updateCarrierSettingsRequestBody** | [**UpdateCarrierSettingsRequestBody**](../../docs//models/UpdateCarrierSettingsRequestBody.md) | | | +| **updateCarrierSettingsRequestBody** | [**UpdateCarrierSettingsRequestBody**](../../docs/\models/UpdateCarrierSettingsRequestBody.md) | | | | **carrierId** | **string** | Carrier ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/CarriersApi.md b/docs/apis/CarriersApi.md index 56a3843..e48ae2d 100644 --- a/docs/apis/CarriersApi.md +++ b/docs/apis/CarriersApi.md @@ -60,7 +60,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **addFundsToCarrierRequestBody** | [**AddFundsToCarrierRequestBody**](../../docs//models/AddFundsToCarrierRequestBody.md) | | | +| **addFundsToCarrierRequestBody** | [**AddFundsToCarrierRequestBody**](../../docs/\models/AddFundsToCarrierRequestBody.md) | | | | **carrierId** | **string** | Carrier ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/InsuranceApi.md b/docs/apis/InsuranceApi.md index 61147e8..3e7253c 100644 --- a/docs/apis/InsuranceApi.md +++ b/docs/apis/InsuranceApi.md @@ -56,7 +56,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **addFundsToInsuranceRequestBody** | [**AddFundsToInsuranceRequestBody**](../../docs//models/AddFundsToInsuranceRequestBody.md) | | | +| **addFundsToInsuranceRequestBody** | [**AddFundsToInsuranceRequestBody**](../../docs/\models/AddFundsToInsuranceRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -112,7 +112,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **connectInsurerRequestBody** | [**ConnectInsurerRequestBody**](../../docs//models/ConnectInsurerRequestBody.md) | | | +| **connectInsurerRequestBody** | [**ConnectInsurerRequestBody**](../../docs/\models/ConnectInsurerRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/LabelsApi.md b/docs/apis/LabelsApi.md index c5c302f..60efeff 100644 --- a/docs/apis/LabelsApi.md +++ b/docs/apis/LabelsApi.md @@ -2,6 +2,7 @@ | Method | Description | |--------|-------------| +| [**CreateCombinedLabelDocument**](LabelsApi.md#createcombinedlabeldocument) | Created Combined Label Document | | [**CreateLabel**](LabelsApi.md#createlabel) | Purchase Label | | [**CreateLabelFromRate**](LabelsApi.md#createlabelfromrate) | Purchase Label with Rate ID | | [**CreateLabelFromShipment**](LabelsApi.md#createlabelfromshipment) | Purchase Label with Shipment ID | @@ -12,6 +13,62 @@ | [**ListLabels**](LabelsApi.md#listlabels) | List labels | | [**VoidLabel**](LabelsApi.md#voidlabel) | Void a Label By ID | + +# **CreateCombinedLabelDocument** +```csharp +CreateCombinedLabelDocumentResponseBodyYaml CreateCombinedLabelDocument (CreateCombinedLabelDocumentRequestBody createCombinedLabelDocumentRequestBody, CancellationToken cancellationToken = default) + +CreateCombinedLabelDocumentResponseBodyYaml CreateCombinedLabelDocument (HttpClient methodClient, CreateCombinedLabelDocumentRequestBody createCombinedLabelDocumentRequestBody, CancellationToken cancellationToken = default) +``` + +Created Combined Label Document + +Download a combined label file + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateCombinedLabelDocumentExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createCombinedLabelDocumentRequestBody = new CreateCombinedLabelDocumentRequestBody(); + + try + { + // Created Combined Label Document + CreateCombinedLabelDocumentResponseBodyYaml result = await shipEngine.CreateCombinedLabelDocument(createCombinedLabelDocumentRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.CreateCombinedLabelDocument: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | +| **createCombinedLabelDocumentRequestBody** | [**CreateCombinedLabelDocumentRequestBody**](../../docs/\models/CreateCombinedLabelDocumentRequestBody.md) | | | +| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | + +### Return type + +[**CreateCombinedLabelDocumentResponseBodyYaml**](../models/CreateCombinedLabelDocumentResponseBodyYaml.md) + # **CreateLabel** ```csharp @@ -61,7 +118,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createLabelRequestBody** | [**CreateLabelRequestBody**](../../docs//models/CreateLabelRequestBody.md) | | | +| **createLabelRequestBody** | [**CreateLabelRequestBody**](../../docs/\models/CreateLabelRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -118,7 +175,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createLabelFromRateRequestBody** | [**CreateLabelFromRateRequestBody**](../../docs//models/CreateLabelFromRateRequestBody.md) | | | +| **createLabelFromRateRequestBody** | [**CreateLabelFromRateRequestBody**](../../docs/\models/CreateLabelFromRateRequestBody.md) | | | | **rateId** | **string** | Rate ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -176,7 +233,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createLabelFromShipmentRequestBody** | [**CreateLabelFromShipmentRequestBody**](../../docs//models/CreateLabelFromShipmentRequestBody.md) | | | +| **createLabelFromShipmentRequestBody** | [**CreateLabelFromShipmentRequestBody**](../../docs/\models/CreateLabelFromShipmentRequestBody.md) | | | | **shipmentId** | **string** | Shipment ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -234,7 +291,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createReturnLabelRequestBody** | [**CreateReturnLabelRequestBody**](../../docs//models/CreateReturnLabelRequestBody.md) | | | +| **createReturnLabelRequestBody** | [**CreateReturnLabelRequestBody**](../../docs/\models/CreateReturnLabelRequestBody.md) | | | | **labelId** | **string** | Label ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/ManifestsApi.md b/docs/apis/ManifestsApi.md index e5e15c6..3b71a82 100644 --- a/docs/apis/ManifestsApi.md +++ b/docs/apis/ManifestsApi.md @@ -56,7 +56,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createManifestRequestBody** | [**CreateManifestRequestBody**](../../docs//models/CreateManifestRequestBody.md) | | | +| **createManifestRequestBody** | [**CreateManifestRequestBody**](../../docs/\models/CreateManifestRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -236,7 +236,7 @@ namespace Example | **shipDateEnd** | **DateTimeOffset** | ship date end range | [optional] | | **createdAtStart** | **DateTimeOffset** | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) | [optional] | | **createdAtEnd** | **DateTimeOffset** | Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) | [optional] | -| **labelIds** | [**List<string>**](../../docs//models/string.md) | | [optional] | +| **labelIds** | [**List<string>**](../../docs/\models/string.md) | | [optional] | | **warehouseId** | **string** | Warehouse ID | [optional] | | **carrierId** | **string** | Carrier ID | [optional] | | **page** | **int** | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. | [optional] [default to 1] | diff --git a/docs/apis/PackagePickupsApi.md b/docs/apis/PackagePickupsApi.md index b5387d7..d497e07 100644 --- a/docs/apis/PackagePickupsApi.md +++ b/docs/apis/PackagePickupsApi.md @@ -234,7 +234,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **schedulePickupRequestBody** | [**SchedulePickupRequestBody**](../../docs//models/SchedulePickupRequestBody.md) | | | +| **schedulePickupRequestBody** | [**SchedulePickupRequestBody**](../../docs/\models/SchedulePickupRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/PackageTypesApi.md b/docs/apis/PackageTypesApi.md index 4c269d0..cfa8d75 100644 --- a/docs/apis/PackageTypesApi.md +++ b/docs/apis/PackageTypesApi.md @@ -57,7 +57,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createPackageTypeRequestBody** | [**CreatePackageTypeRequestBody**](../../docs//models/CreatePackageTypeRequestBody.md) | | | +| **createPackageTypeRequestBody** | [**CreatePackageTypeRequestBody**](../../docs/\models/CreatePackageTypeRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -280,7 +280,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updatePackageTypeRequestBody** | [**UpdatePackageTypeRequestBody**](../../docs//models/UpdatePackageTypeRequestBody.md) | | | +| **updatePackageTypeRequestBody** | [**UpdatePackageTypeRequestBody**](../../docs/\models/UpdatePackageTypeRequestBody.md) | | | | **packageId** | **string** | Package ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/RatesApi.md b/docs/apis/RatesApi.md index 60f105d..3c6ebc8 100644 --- a/docs/apis/RatesApi.md +++ b/docs/apis/RatesApi.md @@ -56,7 +56,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **calculateRatesRequestBody** | [**CalculateRatesRequestBody**](../../docs//models/CalculateRatesRequestBody.md) | | | +| **calculateRatesRequestBody** | [**CalculateRatesRequestBody**](../../docs/\models/CalculateRatesRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -112,7 +112,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **compareBulkRatesRequestBody** | [**CompareBulkRatesRequestBody**](../../docs//models/CompareBulkRatesRequestBody.md) | | | +| **compareBulkRatesRequestBody** | [**CompareBulkRatesRequestBody**](../../docs/\models/CompareBulkRatesRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -168,7 +168,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **estimateRatesRequestBody** | [**EstimateRatesRequestBody**](../../docs//models/EstimateRatesRequestBody.md) | | | +| **estimateRatesRequestBody** | [**EstimateRatesRequestBody**](../../docs/\models/EstimateRatesRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/ServicePointsApi.md b/docs/apis/ServicePointsApi.md index 78ef682..89f8b79 100644 --- a/docs/apis/ServicePointsApi.md +++ b/docs/apis/ServicePointsApi.md @@ -114,7 +114,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **getServicePointsRequest** | [**GetServicePointsRequest**](../../docs//models/GetServicePointsRequest.md) | | | +| **getServicePointsRequest** | [**GetServicePointsRequest**](../../docs/\models/GetServicePointsRequest.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/ShipmentsApi.md b/docs/apis/ShipmentsApi.md index 2885dac..1ac4872 100644 --- a/docs/apis/ShipmentsApi.md +++ b/docs/apis/ShipmentsApi.md @@ -120,7 +120,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createShipmentsRequestBody** | [**CreateShipmentsRequestBody**](../../docs//models/CreateShipmentsRequestBody.md) | | | +| **createShipmentsRequestBody** | [**CreateShipmentsRequestBody**](../../docs/\models/CreateShipmentsRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -424,7 +424,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **parseShipmentRequestBody** | [**ParseShipmentRequestBody**](../../docs//models/ParseShipmentRequestBody.md) | The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use. | | +| **parseShipmentRequestBody** | [**ParseShipmentRequestBody**](../../docs/\models/ParseShipmentRequestBody.md) | The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use. | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -535,7 +535,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateShipmentsTagsRequestBody** | [**UpdateShipmentsTagsRequestBody**](../../docs//models/UpdateShipmentsTagsRequestBody.md) | | | +| **updateShipmentsTagsRequestBody** | [**UpdateShipmentsTagsRequestBody**](../../docs/\models/UpdateShipmentsTagsRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -708,7 +708,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateShipmentRequestBody** | [**UpdateShipmentRequestBody**](../../docs//models/UpdateShipmentRequestBody.md) | | | +| **updateShipmentRequestBody** | [**UpdateShipmentRequestBody**](../../docs/\models/UpdateShipmentRequestBody.md) | | | | **shipmentId** | **string** | Shipment ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/TagsApi.md b/docs/apis/TagsApi.md index 5e9041e..d12cf7d 100644 --- a/docs/apis/TagsApi.md +++ b/docs/apis/TagsApi.md @@ -3,6 +3,7 @@ | Method | Description | |--------|-------------| | [**CreateTag**](TagsApi.md#createtag) | Create a New Tag | +| [**CreateTag_0**](TagsApi.md#createtag_0) | Create a New Tag | | [**DeleteTag**](TagsApi.md#deletetag) | Delete Tag | | [**ListTags**](TagsApi.md#listtags) | Get Tags | | [**RenameTag**](TagsApi.md#renametag) | Update Tag Name | @@ -10,14 +11,14 @@ # **CreateTag** ```csharp -CreateTagResponseBody CreateTag (string tagName, CancellationToken cancellationToken = default) +CreateTagResponseBody CreateTag (CreateTagRequestBody createTagRequestBody, CancellationToken cancellationToken = default) -CreateTagResponseBody CreateTag (HttpClient methodClient, string tagName, CancellationToken cancellationToken = default) +CreateTagResponseBody CreateTag (HttpClient methodClient, CreateTagRequestBody createTagRequestBody, CancellationToken cancellationToken = default) ``` Create a New Tag -Create a new Tag for customizing how you track your shipments +Create a new tag for customizing how you track your shipments. ### Example ```csharp @@ -33,12 +34,12 @@ namespace Example public static async Task Main() { var shipEngine = new ShipEngine("api_key"); - var tagName = "tagName_example"; + var createTagRequestBody = new CreateTagRequestBody(); try { // Create a New Tag - CreateTagResponseBody result = await shipEngine.CreateTag(tagName); + CreateTagResponseBody result = await shipEngine.CreateTag(createTagRequestBody); Debug.WriteLine(result); } catch (ShipEngineException e) @@ -52,6 +53,62 @@ namespace Example } ``` +### Parameters +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | +| **createTagRequestBody** | [**CreateTagRequestBody**](../../docs/\models/CreateTagRequestBody.md) | | | +| **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | + +### Return type + +[**CreateTagResponseBody**](../models/CreateTagResponseBody.md) + + +# **CreateTag_0** +```csharp +CreateTagResponseBody CreateTag_0 (string tagName, CancellationToken cancellationToken = default) + +CreateTagResponseBody CreateTag_0 (HttpClient methodClient, string tagName, CancellationToken cancellationToken = default) +``` + +Create a New Tag + +Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateTag_0Example + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var tagName = "tagName_example"; + + try + { + // Create a New Tag + CreateTagResponseBody result = await shipEngine.CreateTag_0(tagName); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling TagsApi.CreateTag_0: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + ### Parameters | Name | Type | Description | Notes | |------|------|-------------|-------| diff --git a/docs/apis/WarehousesApi.md b/docs/apis/WarehousesApi.md index 07ddd9d..7a4621f 100644 --- a/docs/apis/WarehousesApi.md +++ b/docs/apis/WarehousesApi.md @@ -58,7 +58,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createWarehouseRequestBody** | [**CreateWarehouseRequestBody**](../../docs//models/CreateWarehouseRequestBody.md) | | | +| **createWarehouseRequestBody** | [**CreateWarehouseRequestBody**](../../docs/\models/CreateWarehouseRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -281,7 +281,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateWarehouseRequestBody** | [**UpdateWarehouseRequestBody**](../../docs//models/UpdateWarehouseRequestBody.md) | | | +| **updateWarehouseRequestBody** | [**UpdateWarehouseRequestBody**](../../docs/\models/UpdateWarehouseRequestBody.md) | | | | **warehouseId** | **string** | Warehouse ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -339,7 +339,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateWarehouseSettingsRequestBody** | [**UpdateWarehouseSettingsRequestBody**](../../docs//models/UpdateWarehouseSettingsRequestBody.md) | | | +| **updateWarehouseSettingsRequestBody** | [**UpdateWarehouseSettingsRequestBody**](../../docs/\models/UpdateWarehouseSettingsRequestBody.md) | | | | **warehouseId** | **string** | Warehouse ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/WebhooksApi.md b/docs/apis/WebhooksApi.md index 8638f7b..37d7200 100644 --- a/docs/apis/WebhooksApi.md +++ b/docs/apis/WebhooksApi.md @@ -57,7 +57,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createWebhookRequestBody** | [**CreateWebhookRequestBody**](../../docs//models/CreateWebhookRequestBody.md) | | | +| **createWebhookRequestBody** | [**CreateWebhookRequestBody**](../../docs/\models/CreateWebhookRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -280,7 +280,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateWebhookRequestBody** | [**UpdateWebhookRequestBody**](../../docs//models/UpdateWebhookRequestBody.md) | | | +| **updateWebhookRequestBody** | [**UpdateWebhookRequestBody**](../../docs/\models/UpdateWebhookRequestBody.md) | | | | **webhookId** | **string** | Webhook ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/models/CreateCombinedLabelDocumentRequestBody.md b/docs/models/CreateCombinedLabelDocumentRequestBody.md new file mode 100644 index 0000000..96ec00b --- /dev/null +++ b/docs/models/CreateCombinedLabelDocumentRequestBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.CreateCombinedLabelDocumentRequestBody +A create combined label document request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LabelDownloadType** | **string** | The download type for the combined label document; note that currently only `\"inline\"` is supported. | [optional] +**LabelFormat** | **string** | The file format for the combined label document; note that currently only `\"pdf\"` is supported. | [optional] +**LabelIds** | **List<string>** | The list of up to 30 label ids to include in the combined label document. Note that to avoid response size limits, you should only expect to be able to combine 30 single page labels similar in size to that of USPS labels. | [optional] + diff --git a/docs/models/CreateCombinedLabelDocumentResponseBodyYaml.md b/docs/models/CreateCombinedLabelDocumentResponseBodyYaml.md new file mode 100644 index 0000000..7bdac13 --- /dev/null +++ b/docs/models/CreateCombinedLabelDocumentResponseBodyYaml.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.CreateCombinedLabelDocumentResponseBodyYaml +A create combined label document response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | The download for the combined label document | [optional] [readonly] + diff --git a/docs/models/CreateLabelFromRateResponseBody.md b/docs/models/CreateLabelFromRateResponseBody.md index 809cb55..281ea21 100644 --- a/docs/models/CreateLabelFromRateResponseBody.md +++ b/docs/models/CreateLabelFromRateResponseBody.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **CarrierCode** | **string** | The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] [readonly] **CarrierId** | **string** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly] **ChargeEvent** | **LabelChargeEvent** | The label charge event. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] [readonly] **CreatedAt** | **DateTimeOffset** | The date and time that the label was created in ShipEngine. | [optional] [readonly] **DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] **FormDownload** | [**Link**](Link.md) | The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [optional] [readonly] diff --git a/docs/models/CreateLabelFromShipmentResponseBody.md b/docs/models/CreateLabelFromShipmentResponseBody.md index 1d4ec3d..c130be7 100644 --- a/docs/models/CreateLabelFromShipmentResponseBody.md +++ b/docs/models/CreateLabelFromShipmentResponseBody.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **CarrierCode** | **string** | The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] [readonly] **CarrierId** | **string** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly] **ChargeEvent** | **LabelChargeEvent** | The label charge event. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] [readonly] **CreatedAt** | **DateTimeOffset** | The date and time that the label was created in ShipEngine. | [optional] [readonly] **DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] **FormDownload** | [**Link**](Link.md) | The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [optional] [readonly] diff --git a/docs/models/CreateLabelResponseBody.md b/docs/models/CreateLabelResponseBody.md index 1e5f4ff..5738f53 100644 --- a/docs/models/CreateLabelResponseBody.md +++ b/docs/models/CreateLabelResponseBody.md @@ -30,6 +30,7 @@ Name | Type | Description | Notes **TrackingStatus** | **TrackingStatus** | The current status of the package, such as `in_transit` or `delivered` | [readonly] **Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [readonly] **AlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Additional information some carriers may provide by which to identify a given label in their system. | [optional] [readonly] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] [readonly] **FormDownload** | [**Link**](Link.md) | The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [readonly] **InsuranceClaim** | [**Link**](Link.md) | The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission. | [readonly] **LabelDownloadType** | **LabelDownloadType** | | [optional] diff --git a/docs/models/CreateReturnLabelResponseBody.md b/docs/models/CreateReturnLabelResponseBody.md index 59cadf6..226358a 100644 --- a/docs/models/CreateReturnLabelResponseBody.md +++ b/docs/models/CreateReturnLabelResponseBody.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **CarrierCode** | **string** | The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] [readonly] **CarrierId** | **string** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly] **ChargeEvent** | **LabelChargeEvent** | The label charge event. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] [readonly] **CreatedAt** | **DateTimeOffset** | The date and time that the label was created in ShipEngine. | [optional] [readonly] **DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] **FormDownload** | [**Link**](Link.md) | The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [optional] [readonly] diff --git a/docs/models/CreateTagRequestBody.md b/docs/models/CreateTagRequestBody.md new file mode 100644 index 0000000..e548f23 --- /dev/null +++ b/docs/models/CreateTagRequestBody.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.CreateTagRequestBody +A create tag request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The tag name. | +**Color** | **string** | A hex-coded string identifying the color of the tag. | [optional] + diff --git a/docs/models/CreateTagResponseBody.md b/docs/models/CreateTagResponseBody.md index 7f7990a..db1bd96 100644 --- a/docs/models/CreateTagResponseBody.md +++ b/docs/models/CreateTagResponseBody.md @@ -6,4 +6,6 @@ Response body for creating tags Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | The tag name. | +**Color** | **string** | A hex-coded string identifying the color of the tag. | [optional] +**TagId** | **int** | An integer uniquely identifying a tag. | [optional] [readonly] diff --git a/docs/models/EstimatedImportCharges.md b/docs/models/EstimatedImportCharges.md new file mode 100644 index 0000000..9e6fc79 --- /dev/null +++ b/docs/models/EstimatedImportCharges.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.EstimatedImportCharges +Estimated import charges for commercial invoices for international shipments. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Duties** | [**MonetaryValue**](MonetaryValue.md) | Estimated import duties. | [optional] +**Taxes** | [**MonetaryValue**](MonetaryValue.md) | Estimated import taxes. | [optional] + diff --git a/docs/models/GetLabelByExternalShipmentIdResponseBody.md b/docs/models/GetLabelByExternalShipmentIdResponseBody.md index 71950a4..022899b 100644 --- a/docs/models/GetLabelByExternalShipmentIdResponseBody.md +++ b/docs/models/GetLabelByExternalShipmentIdResponseBody.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **CarrierCode** | **string** | The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] [readonly] **CarrierId** | **string** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly] **ChargeEvent** | **LabelChargeEvent** | The label charge event. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] [readonly] **CreatedAt** | **DateTimeOffset** | The date and time that the label was created in ShipEngine. | [optional] [readonly] **DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] **FormDownload** | [**Link**](Link.md) | The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [optional] [readonly] diff --git a/docs/models/GetLabelByIdResponseBody.md b/docs/models/GetLabelByIdResponseBody.md index 4b4fb7e..b65fd76 100644 --- a/docs/models/GetLabelByIdResponseBody.md +++ b/docs/models/GetLabelByIdResponseBody.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **CarrierCode** | **string** | The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] [readonly] **CarrierId** | **string** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly] **ChargeEvent** | **LabelChargeEvent** | The label charge event. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] [readonly] **CreatedAt** | **DateTimeOffset** | The date and time that the label was created in ShipEngine. | [optional] [readonly] **DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] **FormDownload** | [**Link**](Link.md) | The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [optional] [readonly] diff --git a/docs/models/InvoiceAdditionalDetails.md b/docs/models/InvoiceAdditionalDetails.md index 7a3bdb9..9c43638 100644 --- a/docs/models/InvoiceAdditionalDetails.md +++ b/docs/models/InvoiceAdditionalDetails.md @@ -6,6 +6,7 @@ The additional information to put on commercial invoice Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Discount** | [**MonetaryValue**](MonetaryValue.md) | Discount for shipment. | [optional] +**EstimatedImportCharges** | [**EstimatedImportCharges**](EstimatedImportCharges.md) | Estimated import charges for commercial invoices for international shipments. | [optional] **FreightCharge** | [**MonetaryValue**](MonetaryValue.md) | Freight Charge for shipment. | [optional] **InsuranceCharge** | [**MonetaryValue**](MonetaryValue.md) | Insurance Charge for shipment. | [optional] **OtherCharge** | [**MonetaryValue**](MonetaryValue.md) | Other charge for shipment. | [optional] diff --git a/docs/models/Label.md b/docs/models/Label.md index 6d99d56..dd14796 100644 --- a/docs/models/Label.md +++ b/docs/models/Label.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **CarrierCode** | **string** | The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] [readonly] **CarrierId** | **string** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly] **ChargeEvent** | **LabelChargeEvent** | The label charge event. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] [readonly] **CreatedAt** | **DateTimeOffset** | The date and time that the label was created in ShipEngine. | [optional] [readonly] **DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] **FormDownload** | [**Link**](Link.md) | The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [optional] [readonly] diff --git a/docs/models/RateRequestBody.md b/docs/models/RateRequestBody.md index 0bc7eb3..5bad92a 100644 --- a/docs/models/RateRequestBody.md +++ b/docs/models/RateRequestBody.md @@ -10,5 +10,6 @@ Name | Type | Description | Notes **IsReturn** | **bool** | Indicate if it's a return shipment | [optional] **PackageTypes** | **List<string>** | | [optional] **PreferredCurrency** | **string** | The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html | [optional] +**RateType** | **string** | Indicates what type of rating to perform | [optional] **ServiceCodes** | **List<string>** | | [optional] diff --git a/docs/models/Tag.md b/docs/models/Tag.md index 34cb6be..84de4da 100644 --- a/docs/models/Tag.md +++ b/docs/models/Tag.md @@ -6,4 +6,6 @@ Tags are arbitrary strings that you can use to categorize shipments. For exampl Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | The tag name. | +**Color** | **string** | A hex-coded string identifying the color of the tag. | [optional] +**TagId** | **int** | An integer uniquely identifying a tag. | [optional] [readonly] From 980038e39b64ce213cf84de970bd3d2f41cf7884 Mon Sep 17 00:00:00 2001 From: Lexander Gonzalez Date: Fri, 14 Mar 2025 09:36:44 +0100 Subject: [PATCH 4/6] feat: updating version and changelog --- CHANGELOG.md | 10 ++++++++++ ShipEngineSDK/ShipEngineSDK.csproj | 2 +- openapitools.json | 2 +- 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4a5f249..b4ac478 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -223,3 +223,13 @@ Fixed handling of No Content responses ### Changed - Marked v2 methods as obsolete + +## 3.0.1 + +### Added + +- Created new EstimatedImportCharges model for commercial invoices for international shipments. + +### Changed + +- Extend shipment endpoints to request, create, update and delete estimated import charges. diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index bd9a837..68bef63 100644 --- a/ShipEngineSDK/ShipEngineSDK.csproj +++ b/ShipEngineSDK/ShipEngineSDK.csproj @@ -4,7 +4,7 @@ ShipEngine sdk;rest;api;shipping;rates;label;tracking;cost;address;validation;normalization;fedex;ups;usps; - 3.0.0 + 3.0.1 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/openapitools.json b/openapitools.json index e8b126b..a5e67e6 100644 --- a/openapitools.json +++ b/openapitools.json @@ -14,7 +14,7 @@ "ignoreFileOverride": "./.openapi-generator-ignore", "library": "generichost", "additionalProperties": { - "packageVersion": "3.0.0", + "packageVersion": "3.0.1", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", From 441f0abbf364ba2f88a8b9e12a34bc18a4e20fd5 Mon Sep 17 00:00:00 2001 From: Lexander Gonzalez Date: Fri, 14 Mar 2025 09:52:02 +0100 Subject: [PATCH 5/6] feat: formatting readme urls --- README.md | 190 +++++++++++++++++++++++++++--------------------------- 1 file changed, 95 insertions(+), 95 deletions(-) diff --git a/README.md b/README.md index 1f1d127..7fcd844 100644 --- a/README.md +++ b/README.md @@ -52,101 +52,101 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap API | Method | Description ------------ | ------------- | ------------- -*Account* | [**CreateAccountImage**](docs/\apis/AccountApi.md#createaccountimage) | Create an Account Image -*Account* | [**DeleteAccountImageById**](docs/\apis/AccountApi.md#deleteaccountimagebyid) | Delete Account Image By Id -*Account* | [**GetAccountSettingsImagesById**](docs/\apis/AccountApi.md#getaccountsettingsimagesbyid) | Get Account Image By ID -*Account* | [**ListAccountImages**](docs/\apis/AccountApi.md#listaccountimages) | List Account Images -*Account* | [**ListAccountSettings**](docs/\apis/AccountApi.md#listaccountsettings) | List Account Settings -*Account* | [**UpdateAccountSettingsImagesById**](docs/\apis/AccountApi.md#updateaccountsettingsimagesbyid) | Update Account Image By ID -*Addresses* | [**ParseAddress**](docs/\apis/AddressesApi.md#parseaddress) | Parse an address -*Addresses* | [**ValidateAddress**](docs/\apis/AddressesApi.md#validateaddress) | Validate An Address -*Batches* | [**AddToBatch**](docs/\apis/BatchesApi.md#addtobatch) | Add to a Batch -*Batches* | [**CreateBatch**](docs/\apis/BatchesApi.md#createbatch) | Create A Batch -*Batches* | [**DeleteBatch**](docs/\apis/BatchesApi.md#deletebatch) | Delete Batch By Id -*Batches* | [**GetBatchByExternalId**](docs/\apis/BatchesApi.md#getbatchbyexternalid) | Get Batch By External ID -*Batches* | [**GetBatchById**](docs/\apis/BatchesApi.md#getbatchbyid) | Get Batch By ID -*Batches* | [**ListBatchErrors**](docs/\apis/BatchesApi.md#listbatcherrors) | Get Batch Errors -*Batches* | [**ListBatches**](docs/\apis/BatchesApi.md#listbatches) | List Batches -*Batches* | [**ProcessBatch**](docs/\apis/BatchesApi.md#processbatch) | Process Batch ID Labels -*Batches* | [**RemoveFromBatch**](docs/\apis/BatchesApi.md#removefrombatch) | Remove From Batch -*Batches* | [**UpdateBatch**](docs/\apis/BatchesApi.md#updatebatch) | Update Batch By Id -*CarrierAccounts* | [**ConnectCarrier**](docs/\apis/CarrierAccountsApi.md#connectcarrier) | Connect a carrier account -*CarrierAccounts* | [**DisconnectCarrier**](docs/\apis/CarrierAccountsApi.md#disconnectcarrier) | Disconnect a carrier -*CarrierAccounts* | [**GetCarrierSettings**](docs/\apis/CarrierAccountsApi.md#getcarriersettings) | Get carrier settings -*CarrierAccounts* | [**UpdateCarrierSettings**](docs/\apis/CarrierAccountsApi.md#updatecarriersettings) | Update carrier settings -*Carriers* | [**AddFundsToCarrier**](docs/\apis/CarriersApi.md#addfundstocarrier) | Add Funds To Carrier -*Carriers* | [**DisconnectCarrierById**](docs/\apis/CarriersApi.md#disconnectcarrierbyid) | Disconnect Carrier by ID -*Carriers* | [**GetCarrierById**](docs/\apis/CarriersApi.md#getcarrierbyid) | Get Carrier By ID -*Carriers* | [**GetCarrierOptions**](docs/\apis/CarriersApi.md#getcarrieroptions) | Get Carrier Options -*Carriers* | [**ListCarrierPackageTypes**](docs/\apis/CarriersApi.md#listcarrierpackagetypes) | List Carrier Package Types -*Carriers* | [**ListCarrierServices**](docs/\apis/CarriersApi.md#listcarrierservices) | List Carrier Services -*Carriers* | [**ListCarriers**](docs/\apis/CarriersApi.md#listcarriers) | List Carriers -*Downloads* | [**DownloadFile**](docs/\apis/DownloadsApi.md#downloadfile) | Download File -*Insurance* | [**AddFundsToInsurance**](docs/\apis/InsuranceApi.md#addfundstoinsurance) | Add Funds To Insurance -*Insurance* | [**ConnectInsurer**](docs/\apis/InsuranceApi.md#connectinsurer) | Connect a Shipsurance Account -*Insurance* | [**DisconnectInsurer**](docs/\apis/InsuranceApi.md#disconnectinsurer) | Disconnect a Shipsurance Account -*Insurance* | [**GetInsuranceBalance**](docs/\apis/InsuranceApi.md#getinsurancebalance) | Get Insurance Funds Balance -*Labels* | [**CreateCombinedLabelDocument**](docs/\apis/LabelsApi.md#createcombinedlabeldocument) | Created Combined Label Document -*Labels* | [**CreateLabel**](docs/\apis/LabelsApi.md#createlabel) | Purchase Label -*Labels* | [**CreateLabelFromRate**](docs/\apis/LabelsApi.md#createlabelfromrate) | Purchase Label with Rate ID -*Labels* | [**CreateLabelFromShipment**](docs/\apis/LabelsApi.md#createlabelfromshipment) | Purchase Label with Shipment ID -*Labels* | [**CreateReturnLabel**](docs/\apis/LabelsApi.md#createreturnlabel) | Create a return label -*Labels* | [**GetLabelByExternalShipmentId**](docs/\apis/LabelsApi.md#getlabelbyexternalshipmentid) | Get Label By External Shipment ID -*Labels* | [**GetLabelById**](docs/\apis/LabelsApi.md#getlabelbyid) | Get Label By ID -*Labels* | [**GetTrackingLogFromLabel**](docs/\apis/LabelsApi.md#gettrackinglogfromlabel) | Get Label Tracking Information -*Labels* | [**ListLabels**](docs/\apis/LabelsApi.md#listlabels) | List labels -*Labels* | [**VoidLabel**](docs/\apis/LabelsApi.md#voidlabel) | Void a Label By ID -*Manifests* | [**CreateManifest**](docs/\apis/ManifestsApi.md#createmanifest) | Create Manifest -*Manifests* | [**GetManifestById**](docs/\apis/ManifestsApi.md#getmanifestbyid) | Get Manifest By Id -*Manifests* | [**GetManifestRequestById**](docs/\apis/ManifestsApi.md#getmanifestrequestbyid) | Get Manifest Request By Id -*Manifests* | [**ListManifests**](docs/\apis/ManifestsApi.md#listmanifests) | List Manifests -*PackagePickups* | [**DeleteScheduledPickup**](docs/\apis/PackagePickupsApi.md#deletescheduledpickup) | Delete a Scheduled Pickup -*PackagePickups* | [**GetPickupById**](docs/\apis/PackagePickupsApi.md#getpickupbyid) | Get Pickup By ID -*PackagePickups* | [**ListScheduledPickups**](docs/\apis/PackagePickupsApi.md#listscheduledpickups) | List Scheduled Pickups -*PackagePickups* | [**SchedulePickup**](docs/\apis/PackagePickupsApi.md#schedulepickup) | Schedule a Pickup -*PackageTypes* | [**CreatePackageType**](docs/\apis/PackageTypesApi.md#createpackagetype) | Create Custom Package Type -*PackageTypes* | [**DeletePackageType**](docs/\apis/PackageTypesApi.md#deletepackagetype) | Delete A Custom Package By ID -*PackageTypes* | [**GetPackageTypeById**](docs/\apis/PackageTypesApi.md#getpackagetypebyid) | Get Custom Package Type By ID -*PackageTypes* | [**ListPackageTypes**](docs/\apis/PackageTypesApi.md#listpackagetypes) | List Custom Package Types -*PackageTypes* | [**UpdatePackageType**](docs/\apis/PackageTypesApi.md#updatepackagetype) | Update Custom Package Type By ID -*Rates* | [**CalculateRates**](docs/\apis/RatesApi.md#calculaterates) | Get Shipping Rates -*Rates* | [**CompareBulkRates**](docs/\apis/RatesApi.md#comparebulkrates) | Get Bulk Rates -*Rates* | [**EstimateRates**](docs/\apis/RatesApi.md#estimaterates) | Estimate Rates -*Rates* | [**GetRateById**](docs/\apis/RatesApi.md#getratebyid) | Get Rate By ID -*ServicePoints* | [**ServicePointsGetById**](docs/\apis/ServicePointsApi.md#servicepointsgetbyid) | Get Service Point By ID -*ServicePoints* | [**ServicePointsList**](docs/\apis/ServicePointsApi.md#servicepointslist) | List Service Points -*Shipments* | [**CancelShipments**](docs/\apis/ShipmentsApi.md#cancelshipments) | Cancel a Shipment -*Shipments* | [**CreateShipments**](docs/\apis/ShipmentsApi.md#createshipments) | Create Shipments -*Shipments* | [**GetShipmentByExternalId**](docs/\apis/ShipmentsApi.md#getshipmentbyexternalid) | Get Shipment By External ID -*Shipments* | [**GetShipmentById**](docs/\apis/ShipmentsApi.md#getshipmentbyid) | Get Shipment By ID -*Shipments* | [**ListShipmentRates**](docs/\apis/ShipmentsApi.md#listshipmentrates) | Get Shipment Rates -*Shipments* | [**ListShipments**](docs/\apis/ShipmentsApi.md#listshipments) | List Shipments -*Shipments* | [**ParseShipment**](docs/\apis/ShipmentsApi.md#parseshipment) | Parse shipping info -*Shipments* | [**ShipmentsListTags**](docs/\apis/ShipmentsApi.md#shipmentslisttags) | Get Shipment Tags -*Shipments* | [**ShipmentsUpdateTags**](docs/\apis/ShipmentsApi.md#shipmentsupdatetags) | Update Shipments Tags -*Shipments* | [**TagShipment**](docs/\apis/ShipmentsApi.md#tagshipment) | Add Tag to Shipment -*Shipments* | [**UntagShipment**](docs/\apis/ShipmentsApi.md#untagshipment) | Remove Tag from Shipment -*Shipments* | [**UpdateShipment**](docs/\apis/ShipmentsApi.md#updateshipment) | Update Shipment By ID -*Tags* | [**CreateTag**](docs/\apis/TagsApi.md#createtag) | Create a New Tag -*Tags* | [**CreateTag_0**](docs/\apis/TagsApi.md#createtag_0) | Create a New Tag -*Tags* | [**DeleteTag**](docs/\apis/TagsApi.md#deletetag) | Delete Tag -*Tags* | [**ListTags**](docs/\apis/TagsApi.md#listtags) | Get Tags -*Tags* | [**RenameTag**](docs/\apis/TagsApi.md#renametag) | Update Tag Name -*Tokens* | [**TokensGetEphemeralToken**](docs/\apis/TokensApi.md#tokensgetephemeraltoken) | Get Ephemeral Token -*Tracking* | [**GetTrackingLog**](docs/\apis/TrackingApi.md#gettrackinglog) | Get Tracking Information -*Tracking* | [**StartTracking**](docs/\apis/TrackingApi.md#starttracking) | Start Tracking a Package -*Tracking* | [**StopTracking**](docs/\apis/TrackingApi.md#stoptracking) | Stop Tracking a Package -*Warehouses* | [**CreateWarehouse**](docs/\apis/WarehousesApi.md#createwarehouse) | Create Warehouse -*Warehouses* | [**DeleteWarehouse**](docs/\apis/WarehousesApi.md#deletewarehouse) | Delete Warehouse By ID -*Warehouses* | [**GetWarehouseById**](docs/\apis/WarehousesApi.md#getwarehousebyid) | Get Warehouse By Id -*Warehouses* | [**ListWarehouses**](docs/\apis/WarehousesApi.md#listwarehouses) | List Warehouses -*Warehouses* | [**UpdateWarehouse**](docs/\apis/WarehousesApi.md#updatewarehouse) | Update Warehouse By Id -*Warehouses* | [**UpdateWarehouseSettings**](docs/\apis/WarehousesApi.md#updatewarehousesettings) | Update Warehouse Settings -*Webhooks* | [**CreateWebhook**](docs/\apis/WebhooksApi.md#createwebhook) | Create a Webhook -*Webhooks* | [**DeleteWebhook**](docs/\apis/WebhooksApi.md#deletewebhook) | Delete Webhook By ID -*Webhooks* | [**GetWebhookById**](docs/\apis/WebhooksApi.md#getwebhookbyid) | Get Webhook By ID -*Webhooks* | [**ListWebhooks**](docs/\apis/WebhooksApi.md#listwebhooks) | List Webhooks -*Webhooks* | [**UpdateWebhook**](docs/\apis/WebhooksApi.md#updatewebhook) | Update a Webhook +*Account* | [**CreateAccountImage**](docs//apis/AccountApi.md#createaccountimage) | Create an Account Image +*Account* | [**DeleteAccountImageById**](docs//apis/AccountApi.md#deleteaccountimagebyid) | Delete Account Image By Id +*Account* | [**GetAccountSettingsImagesById**](docs//apis/AccountApi.md#getaccountsettingsimagesbyid) | Get Account Image By ID +*Account* | [**ListAccountImages**](docs//apis/AccountApi.md#listaccountimages) | List Account Images +*Account* | [**ListAccountSettings**](docs//apis/AccountApi.md#listaccountsettings) | List Account Settings +*Account* | [**UpdateAccountSettingsImagesById**](docs//apis/AccountApi.md#updateaccountsettingsimagesbyid) | Update Account Image By ID +*Addresses* | [**ParseAddress**](docs//apis/AddressesApi.md#parseaddress) | Parse an address +*Addresses* | [**ValidateAddress**](docs//apis/AddressesApi.md#validateaddress) | Validate An Address +*Batches* | [**AddToBatch**](docs//apis/BatchesApi.md#addtobatch) | Add to a Batch +*Batches* | [**CreateBatch**](docs//apis/BatchesApi.md#createbatch) | Create A Batch +*Batches* | [**DeleteBatch**](docs//apis/BatchesApi.md#deletebatch) | Delete Batch By Id +*Batches* | [**GetBatchByExternalId**](docs//apis/BatchesApi.md#getbatchbyexternalid) | Get Batch By External ID +*Batches* | [**GetBatchById**](docs//apis/BatchesApi.md#getbatchbyid) | Get Batch By ID +*Batches* | [**ListBatchErrors**](docs//apis/BatchesApi.md#listbatcherrors) | Get Batch Errors +*Batches* | [**ListBatches**](docs//apis/BatchesApi.md#listbatches) | List Batches +*Batches* | [**ProcessBatch**](docs//apis/BatchesApi.md#processbatch) | Process Batch ID Labels +*Batches* | [**RemoveFromBatch**](docs//apis/BatchesApi.md#removefrombatch) | Remove From Batch +*Batches* | [**UpdateBatch**](docs//apis/BatchesApi.md#updatebatch) | Update Batch By Id +*CarrierAccounts* | [**ConnectCarrier**](docs//apis/CarrierAccountsApi.md#connectcarrier) | Connect a carrier account +*CarrierAccounts* | [**DisconnectCarrier**](docs//apis/CarrierAccountsApi.md#disconnectcarrier) | Disconnect a carrier +*CarrierAccounts* | [**GetCarrierSettings**](docs//apis/CarrierAccountsApi.md#getcarriersettings) | Get carrier settings +*CarrierAccounts* | [**UpdateCarrierSettings**](docs//apis/CarrierAccountsApi.md#updatecarriersettings) | Update carrier settings +*Carriers* | [**AddFundsToCarrier**](docs//apis/CarriersApi.md#addfundstocarrier) | Add Funds To Carrier +*Carriers* | [**DisconnectCarrierById**](docs//apis/CarriersApi.md#disconnectcarrierbyid) | Disconnect Carrier by ID +*Carriers* | [**GetCarrierById**](docs//apis/CarriersApi.md#getcarrierbyid) | Get Carrier By ID +*Carriers* | [**GetCarrierOptions**](docs//apis/CarriersApi.md#getcarrieroptions) | Get Carrier Options +*Carriers* | [**ListCarrierPackageTypes**](docs//apis/CarriersApi.md#listcarrierpackagetypes) | List Carrier Package Types +*Carriers* | [**ListCarrierServices**](docs//apis/CarriersApi.md#listcarrierservices) | List Carrier Services +*Carriers* | [**ListCarriers**](docs//apis/CarriersApi.md#listcarriers) | List Carriers +*Downloads* | [**DownloadFile**](docs//apis/DownloadsApi.md#downloadfile) | Download File +*Insurance* | [**AddFundsToInsurance**](docs//apis/InsuranceApi.md#addfundstoinsurance) | Add Funds To Insurance +*Insurance* | [**ConnectInsurer**](docs//apis/InsuranceApi.md#connectinsurer) | Connect a Shipsurance Account +*Insurance* | [**DisconnectInsurer**](docs//apis/InsuranceApi.md#disconnectinsurer) | Disconnect a Shipsurance Account +*Insurance* | [**GetInsuranceBalance**](docs//apis/InsuranceApi.md#getinsurancebalance) | Get Insurance Funds Balance +*Labels* | [**CreateCombinedLabelDocument**](docs//apis/LabelsApi.md#createcombinedlabeldocument) | Created Combined Label Document +*Labels* | [**CreateLabel**](docs//apis/LabelsApi.md#createlabel) | Purchase Label +*Labels* | [**CreateLabelFromRate**](docs//apis/LabelsApi.md#createlabelfromrate) | Purchase Label with Rate ID +*Labels* | [**CreateLabelFromShipment**](docs//apis/LabelsApi.md#createlabelfromshipment) | Purchase Label with Shipment ID +*Labels* | [**CreateReturnLabel**](docs//apis/LabelsApi.md#createreturnlabel) | Create a return label +*Labels* | [**GetLabelByExternalShipmentId**](docs//apis/LabelsApi.md#getlabelbyexternalshipmentid) | Get Label By External Shipment ID +*Labels* | [**GetLabelById**](docs//apis/LabelsApi.md#getlabelbyid) | Get Label By ID +*Labels* | [**GetTrackingLogFromLabel**](docs//apis/LabelsApi.md#gettrackinglogfromlabel) | Get Label Tracking Information +*Labels* | [**ListLabels**](docs//apis/LabelsApi.md#listlabels) | List labels +*Labels* | [**VoidLabel**](docs//apis/LabelsApi.md#voidlabel) | Void a Label By ID +*Manifests* | [**CreateManifest**](docs//apis/ManifestsApi.md#createmanifest) | Create Manifest +*Manifests* | [**GetManifestById**](docs//apis/ManifestsApi.md#getmanifestbyid) | Get Manifest By Id +*Manifests* | [**GetManifestRequestById**](docs//apis/ManifestsApi.md#getmanifestrequestbyid) | Get Manifest Request By Id +*Manifests* | [**ListManifests**](docs//apis/ManifestsApi.md#listmanifests) | List Manifests +*PackagePickups* | [**DeleteScheduledPickup**](docs//apis/PackagePickupsApi.md#deletescheduledpickup) | Delete a Scheduled Pickup +*PackagePickups* | [**GetPickupById**](docs//apis/PackagePickupsApi.md#getpickupbyid) | Get Pickup By ID +*PackagePickups* | [**ListScheduledPickups**](docs//apis/PackagePickupsApi.md#listscheduledpickups) | List Scheduled Pickups +*PackagePickups* | [**SchedulePickup**](docs//apis/PackagePickupsApi.md#schedulepickup) | Schedule a Pickup +*PackageTypes* | [**CreatePackageType**](docs//apis/PackageTypesApi.md#createpackagetype) | Create Custom Package Type +*PackageTypes* | [**DeletePackageType**](docs//apis/PackageTypesApi.md#deletepackagetype) | Delete A Custom Package By ID +*PackageTypes* | [**GetPackageTypeById**](docs//apis/PackageTypesApi.md#getpackagetypebyid) | Get Custom Package Type By ID +*PackageTypes* | [**ListPackageTypes**](docs//apis/PackageTypesApi.md#listpackagetypes) | List Custom Package Types +*PackageTypes* | [**UpdatePackageType**](docs//apis/PackageTypesApi.md#updatepackagetype) | Update Custom Package Type By ID +*Rates* | [**CalculateRates**](docs//apis/RatesApi.md#calculaterates) | Get Shipping Rates +*Rates* | [**CompareBulkRates**](docs//apis/RatesApi.md#comparebulkrates) | Get Bulk Rates +*Rates* | [**EstimateRates**](docs//apis/RatesApi.md#estimaterates) | Estimate Rates +*Rates* | [**GetRateById**](docs//apis/RatesApi.md#getratebyid) | Get Rate By ID +*ServicePoints* | [**ServicePointsGetById**](docs//apis/ServicePointsApi.md#servicepointsgetbyid) | Get Service Point By ID +*ServicePoints* | [**ServicePointsList**](docs//apis/ServicePointsApi.md#servicepointslist) | List Service Points +*Shipments* | [**CancelShipments**](docs//apis/ShipmentsApi.md#cancelshipments) | Cancel a Shipment +*Shipments* | [**CreateShipments**](docs//apis/ShipmentsApi.md#createshipments) | Create Shipments +*Shipments* | [**GetShipmentByExternalId**](docs//apis/ShipmentsApi.md#getshipmentbyexternalid) | Get Shipment By External ID +*Shipments* | [**GetShipmentById**](docs//apis/ShipmentsApi.md#getshipmentbyid) | Get Shipment By ID +*Shipments* | [**ListShipmentRates**](docs//apis/ShipmentsApi.md#listshipmentrates) | Get Shipment Rates +*Shipments* | [**ListShipments**](docs//apis/ShipmentsApi.md#listshipments) | List Shipments +*Shipments* | [**ParseShipment**](docs//apis/ShipmentsApi.md#parseshipment) | Parse shipping info +*Shipments* | [**ShipmentsListTags**](docs//apis/ShipmentsApi.md#shipmentslisttags) | Get Shipment Tags +*Shipments* | [**ShipmentsUpdateTags**](docs//apis/ShipmentsApi.md#shipmentsupdatetags) | Update Shipments Tags +*Shipments* | [**TagShipment**](docs//apis/ShipmentsApi.md#tagshipment) | Add Tag to Shipment +*Shipments* | [**UntagShipment**](docs//apis/ShipmentsApi.md#untagshipment) | Remove Tag from Shipment +*Shipments* | [**UpdateShipment**](docs//apis/ShipmentsApi.md#updateshipment) | Update Shipment By ID +*Tags* | [**CreateTag**](docs//apis/TagsApi.md#createtag) | Create a New Tag +*Tags* | [**CreateTag_0**](docs//apis/TagsApi.md#createtag_0) | Create a New Tag +*Tags* | [**DeleteTag**](docs//apis/TagsApi.md#deletetag) | Delete Tag +*Tags* | [**ListTags**](docs//apis/TagsApi.md#listtags) | Get Tags +*Tags* | [**RenameTag**](docs//apis/TagsApi.md#renametag) | Update Tag Name +*Tokens* | [**TokensGetEphemeralToken**](docs//apis/TokensApi.md#tokensgetephemeraltoken) | Get Ephemeral Token +*Tracking* | [**GetTrackingLog**](docs//apis/TrackingApi.md#gettrackinglog) | Get Tracking Information +*Tracking* | [**StartTracking**](docs//apis/TrackingApi.md#starttracking) | Start Tracking a Package +*Tracking* | [**StopTracking**](docs//apis/TrackingApi.md#stoptracking) | Stop Tracking a Package +*Warehouses* | [**CreateWarehouse**](docs//apis/WarehousesApi.md#createwarehouse) | Create Warehouse +*Warehouses* | [**DeleteWarehouse**](docs//apis/WarehousesApi.md#deletewarehouse) | Delete Warehouse By ID +*Warehouses* | [**GetWarehouseById**](docs//apis/WarehousesApi.md#getwarehousebyid) | Get Warehouse By Id +*Warehouses* | [**ListWarehouses**](docs//apis/WarehousesApi.md#listwarehouses) | List Warehouses +*Warehouses* | [**UpdateWarehouse**](docs//apis/WarehousesApi.md#updatewarehouse) | Update Warehouse By Id +*Warehouses* | [**UpdateWarehouseSettings**](docs//apis/WarehousesApi.md#updatewarehousesettings) | Update Warehouse Settings +*Webhooks* | [**CreateWebhook**](docs//apis/WebhooksApi.md#createwebhook) | Create a Webhook +*Webhooks* | [**DeleteWebhook**](docs//apis/WebhooksApi.md#deletewebhook) | Delete Webhook By ID +*Webhooks* | [**GetWebhookById**](docs//apis/WebhooksApi.md#getwebhookbyid) | Get Webhook By ID +*Webhooks* | [**ListWebhooks**](docs//apis/WebhooksApi.md#listwebhooks) | List Webhooks +*Webhooks* | [**UpdateWebhook**](docs//apis/WebhooksApi.md#updatewebhook) | Update a Webhook ## Legacy Methods From 0fa4249e2c97e3b0ac56e8d511eb611688d44c74 Mon Sep 17 00:00:00 2001 From: Lexander Gonzalez Date: Tue, 25 Mar 2025 15:38:32 +0100 Subject: [PATCH 6/6] feat: changing version and fixing documentation --- CHANGELOG.md | 2 +- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- docs/apis/AccountApi.md | 4 ++-- docs/apis/AddressesApi.md | 4 ++-- docs/apis/BatchesApi.md | 8 ++++---- docs/apis/CarrierAccountsApi.md | 4 ++-- docs/apis/CarriersApi.md | 2 +- docs/apis/InsuranceApi.md | 4 ++-- docs/apis/LabelsApi.md | 10 +++++----- docs/apis/ManifestsApi.md | 4 ++-- docs/apis/PackagePickupsApi.md | 2 +- docs/apis/PackageTypesApi.md | 4 ++-- docs/apis/RatesApi.md | 6 +++--- docs/apis/ServicePointsApi.md | 2 +- docs/apis/ShipmentsApi.md | 8 ++++---- docs/apis/TagsApi.md | 2 +- docs/apis/WarehousesApi.md | 6 +++--- docs/apis/WebhooksApi.md | 4 ++-- openapitools.json | 2 +- 19 files changed, 40 insertions(+), 40 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b4ac478..9453f6a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -224,7 +224,7 @@ Fixed handling of No Content responses - Marked v2 methods as obsolete -## 3.0.1 +## 3.1.0 ### Added diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 68bef63..6171931 100644 --- a/ShipEngineSDK/ShipEngineSDK.csproj +++ b/ShipEngineSDK/ShipEngineSDK.csproj @@ -4,7 +4,7 @@ ShipEngine sdk;rest;api;shipping;rates;label;tracking;cost;address;validation;normalization;fedex;ups;usps; - 3.0.1 + 3.1.0 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/docs/apis/AccountApi.md b/docs/apis/AccountApi.md index 34b2922..5cecd50 100644 --- a/docs/apis/AccountApi.md +++ b/docs/apis/AccountApi.md @@ -58,7 +58,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createAccountSettingsImageRequestBody** | [**CreateAccountSettingsImageRequestBody**](../../docs/\models/CreateAccountSettingsImageRequestBody.md) | | | +| **createAccountSettingsImageRequestBody** | [**CreateAccountSettingsImageRequestBody**](../../docs//models/CreateAccountSettingsImageRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -335,7 +335,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateAccountSettingsImageRequestBody** | [**UpdateAccountSettingsImageRequestBody**](../../docs/\models/UpdateAccountSettingsImageRequestBody.md) | | | +| **updateAccountSettingsImageRequestBody** | [**UpdateAccountSettingsImageRequestBody**](../../docs//models/UpdateAccountSettingsImageRequestBody.md) | | | | **labelImageId** | **string** | Label Image Id | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/AddressesApi.md b/docs/apis/AddressesApi.md index 72733a2..0a17606 100644 --- a/docs/apis/AddressesApi.md +++ b/docs/apis/AddressesApi.md @@ -54,7 +54,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **parseAddressRequestBody** | [**ParseAddressRequestBody**](../../docs/\models/ParseAddressRequestBody.md) | The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines. | | +| **parseAddressRequestBody** | [**ParseAddressRequestBody**](../../docs//models/ParseAddressRequestBody.md) | The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines. | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -110,7 +110,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **addressToValidate** | [**List<AddressToValidate>**](../../docs/\models/AddressToValidate.md) | | | +| **addressToValidate** | [**List<AddressToValidate>**](../../docs//models/AddressToValidate.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/BatchesApi.md b/docs/apis/BatchesApi.md index 0903ba8..25232c3 100644 --- a/docs/apis/BatchesApi.md +++ b/docs/apis/BatchesApi.md @@ -63,7 +63,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **addToBatchRequestBody** | [**AddToBatchRequestBody**](../../docs/\models/AddToBatchRequestBody.md) | | | +| **addToBatchRequestBody** | [**AddToBatchRequestBody**](../../docs//models/AddToBatchRequestBody.md) | | | | **batchId** | **string** | Batch ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -120,7 +120,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createBatchRequest** | [**CreateBatchRequest**](../../docs/\models/CreateBatchRequest.md) | | | +| **createBatchRequest** | [**CreateBatchRequest**](../../docs//models/CreateBatchRequest.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -471,7 +471,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **processBatchRequestBody** | [**ProcessBatchRequestBody**](../../docs/\models/ProcessBatchRequestBody.md) | | | +| **processBatchRequestBody** | [**ProcessBatchRequestBody**](../../docs//models/ProcessBatchRequestBody.md) | | | | **batchId** | **string** | Batch ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -529,7 +529,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **removeFromBatchRequestBody** | [**RemoveFromBatchRequestBody**](../../docs/\models/RemoveFromBatchRequestBody.md) | | | +| **removeFromBatchRequestBody** | [**RemoveFromBatchRequestBody**](../../docs//models/RemoveFromBatchRequestBody.md) | | | | **batchId** | **string** | Batch ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/CarrierAccountsApi.md b/docs/apis/CarrierAccountsApi.md index bff3dba..1f2b1a7 100644 --- a/docs/apis/CarrierAccountsApi.md +++ b/docs/apis/CarrierAccountsApi.md @@ -58,7 +58,7 @@ namespace Example |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | | **carrierName** | **CarrierName** | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | | -| **connectCarrierRequestBody** | [**ConnectCarrierRequestBody**](../../docs/\models/ConnectCarrierRequestBody.md) | | | +| **connectCarrierRequestBody** | [**ConnectCarrierRequestBody**](../../docs//models/ConnectCarrierRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -233,7 +233,7 @@ namespace Example |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | | **carrierName** | **CarrierNameWithSettings** | The carrier name, such as `ups`, `fedex`, or `dhl_express`. | | -| **updateCarrierSettingsRequestBody** | [**UpdateCarrierSettingsRequestBody**](../../docs/\models/UpdateCarrierSettingsRequestBody.md) | | | +| **updateCarrierSettingsRequestBody** | [**UpdateCarrierSettingsRequestBody**](../../docs//models/UpdateCarrierSettingsRequestBody.md) | | | | **carrierId** | **string** | Carrier ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/CarriersApi.md b/docs/apis/CarriersApi.md index e48ae2d..56a3843 100644 --- a/docs/apis/CarriersApi.md +++ b/docs/apis/CarriersApi.md @@ -60,7 +60,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **addFundsToCarrierRequestBody** | [**AddFundsToCarrierRequestBody**](../../docs/\models/AddFundsToCarrierRequestBody.md) | | | +| **addFundsToCarrierRequestBody** | [**AddFundsToCarrierRequestBody**](../../docs//models/AddFundsToCarrierRequestBody.md) | | | | **carrierId** | **string** | Carrier ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/InsuranceApi.md b/docs/apis/InsuranceApi.md index 3e7253c..61147e8 100644 --- a/docs/apis/InsuranceApi.md +++ b/docs/apis/InsuranceApi.md @@ -56,7 +56,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **addFundsToInsuranceRequestBody** | [**AddFundsToInsuranceRequestBody**](../../docs/\models/AddFundsToInsuranceRequestBody.md) | | | +| **addFundsToInsuranceRequestBody** | [**AddFundsToInsuranceRequestBody**](../../docs//models/AddFundsToInsuranceRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -112,7 +112,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **connectInsurerRequestBody** | [**ConnectInsurerRequestBody**](../../docs/\models/ConnectInsurerRequestBody.md) | | | +| **connectInsurerRequestBody** | [**ConnectInsurerRequestBody**](../../docs//models/ConnectInsurerRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/LabelsApi.md b/docs/apis/LabelsApi.md index 60efeff..b4ca0f4 100644 --- a/docs/apis/LabelsApi.md +++ b/docs/apis/LabelsApi.md @@ -62,7 +62,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createCombinedLabelDocumentRequestBody** | [**CreateCombinedLabelDocumentRequestBody**](../../docs/\models/CreateCombinedLabelDocumentRequestBody.md) | | | +| **createCombinedLabelDocumentRequestBody** | [**CreateCombinedLabelDocumentRequestBody**](../../docs//models/CreateCombinedLabelDocumentRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -118,7 +118,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createLabelRequestBody** | [**CreateLabelRequestBody**](../../docs/\models/CreateLabelRequestBody.md) | | | +| **createLabelRequestBody** | [**CreateLabelRequestBody**](../../docs//models/CreateLabelRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -175,7 +175,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createLabelFromRateRequestBody** | [**CreateLabelFromRateRequestBody**](../../docs/\models/CreateLabelFromRateRequestBody.md) | | | +| **createLabelFromRateRequestBody** | [**CreateLabelFromRateRequestBody**](../../docs//models/CreateLabelFromRateRequestBody.md) | | | | **rateId** | **string** | Rate ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -233,7 +233,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createLabelFromShipmentRequestBody** | [**CreateLabelFromShipmentRequestBody**](../../docs/\models/CreateLabelFromShipmentRequestBody.md) | | | +| **createLabelFromShipmentRequestBody** | [**CreateLabelFromShipmentRequestBody**](../../docs//models/CreateLabelFromShipmentRequestBody.md) | | | | **shipmentId** | **string** | Shipment ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -291,7 +291,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createReturnLabelRequestBody** | [**CreateReturnLabelRequestBody**](../../docs/\models/CreateReturnLabelRequestBody.md) | | | +| **createReturnLabelRequestBody** | [**CreateReturnLabelRequestBody**](../../docs//models/CreateReturnLabelRequestBody.md) | | | | **labelId** | **string** | Label ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/ManifestsApi.md b/docs/apis/ManifestsApi.md index 3b71a82..e5e15c6 100644 --- a/docs/apis/ManifestsApi.md +++ b/docs/apis/ManifestsApi.md @@ -56,7 +56,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createManifestRequestBody** | [**CreateManifestRequestBody**](../../docs/\models/CreateManifestRequestBody.md) | | | +| **createManifestRequestBody** | [**CreateManifestRequestBody**](../../docs//models/CreateManifestRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -236,7 +236,7 @@ namespace Example | **shipDateEnd** | **DateTimeOffset** | ship date end range | [optional] | | **createdAtStart** | **DateTimeOffset** | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) | [optional] | | **createdAtEnd** | **DateTimeOffset** | Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) | [optional] | -| **labelIds** | [**List<string>**](../../docs/\models/string.md) | | [optional] | +| **labelIds** | [**List<string>**](../../docs//models/string.md) | | [optional] | | **warehouseId** | **string** | Warehouse ID | [optional] | | **carrierId** | **string** | Carrier ID | [optional] | | **page** | **int** | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. | [optional] [default to 1] | diff --git a/docs/apis/PackagePickupsApi.md b/docs/apis/PackagePickupsApi.md index d497e07..b5387d7 100644 --- a/docs/apis/PackagePickupsApi.md +++ b/docs/apis/PackagePickupsApi.md @@ -234,7 +234,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **schedulePickupRequestBody** | [**SchedulePickupRequestBody**](../../docs/\models/SchedulePickupRequestBody.md) | | | +| **schedulePickupRequestBody** | [**SchedulePickupRequestBody**](../../docs//models/SchedulePickupRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/PackageTypesApi.md b/docs/apis/PackageTypesApi.md index cfa8d75..4c269d0 100644 --- a/docs/apis/PackageTypesApi.md +++ b/docs/apis/PackageTypesApi.md @@ -57,7 +57,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createPackageTypeRequestBody** | [**CreatePackageTypeRequestBody**](../../docs/\models/CreatePackageTypeRequestBody.md) | | | +| **createPackageTypeRequestBody** | [**CreatePackageTypeRequestBody**](../../docs//models/CreatePackageTypeRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -280,7 +280,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updatePackageTypeRequestBody** | [**UpdatePackageTypeRequestBody**](../../docs/\models/UpdatePackageTypeRequestBody.md) | | | +| **updatePackageTypeRequestBody** | [**UpdatePackageTypeRequestBody**](../../docs//models/UpdatePackageTypeRequestBody.md) | | | | **packageId** | **string** | Package ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/RatesApi.md b/docs/apis/RatesApi.md index 3c6ebc8..60f105d 100644 --- a/docs/apis/RatesApi.md +++ b/docs/apis/RatesApi.md @@ -56,7 +56,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **calculateRatesRequestBody** | [**CalculateRatesRequestBody**](../../docs/\models/CalculateRatesRequestBody.md) | | | +| **calculateRatesRequestBody** | [**CalculateRatesRequestBody**](../../docs//models/CalculateRatesRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -112,7 +112,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **compareBulkRatesRequestBody** | [**CompareBulkRatesRequestBody**](../../docs/\models/CompareBulkRatesRequestBody.md) | | | +| **compareBulkRatesRequestBody** | [**CompareBulkRatesRequestBody**](../../docs//models/CompareBulkRatesRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -168,7 +168,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **estimateRatesRequestBody** | [**EstimateRatesRequestBody**](../../docs/\models/EstimateRatesRequestBody.md) | | | +| **estimateRatesRequestBody** | [**EstimateRatesRequestBody**](../../docs//models/EstimateRatesRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/ServicePointsApi.md b/docs/apis/ServicePointsApi.md index 89f8b79..78ef682 100644 --- a/docs/apis/ServicePointsApi.md +++ b/docs/apis/ServicePointsApi.md @@ -114,7 +114,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **getServicePointsRequest** | [**GetServicePointsRequest**](../../docs/\models/GetServicePointsRequest.md) | | | +| **getServicePointsRequest** | [**GetServicePointsRequest**](../../docs//models/GetServicePointsRequest.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/ShipmentsApi.md b/docs/apis/ShipmentsApi.md index 1ac4872..2885dac 100644 --- a/docs/apis/ShipmentsApi.md +++ b/docs/apis/ShipmentsApi.md @@ -120,7 +120,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createShipmentsRequestBody** | [**CreateShipmentsRequestBody**](../../docs/\models/CreateShipmentsRequestBody.md) | | | +| **createShipmentsRequestBody** | [**CreateShipmentsRequestBody**](../../docs//models/CreateShipmentsRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -424,7 +424,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **parseShipmentRequestBody** | [**ParseShipmentRequestBody**](../../docs/\models/ParseShipmentRequestBody.md) | The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use. | | +| **parseShipmentRequestBody** | [**ParseShipmentRequestBody**](../../docs//models/ParseShipmentRequestBody.md) | The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use. | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -535,7 +535,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateShipmentsTagsRequestBody** | [**UpdateShipmentsTagsRequestBody**](../../docs/\models/UpdateShipmentsTagsRequestBody.md) | | | +| **updateShipmentsTagsRequestBody** | [**UpdateShipmentsTagsRequestBody**](../../docs//models/UpdateShipmentsTagsRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -708,7 +708,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateShipmentRequestBody** | [**UpdateShipmentRequestBody**](../../docs/\models/UpdateShipmentRequestBody.md) | | | +| **updateShipmentRequestBody** | [**UpdateShipmentRequestBody**](../../docs//models/UpdateShipmentRequestBody.md) | | | | **shipmentId** | **string** | Shipment ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/TagsApi.md b/docs/apis/TagsApi.md index d12cf7d..77122d5 100644 --- a/docs/apis/TagsApi.md +++ b/docs/apis/TagsApi.md @@ -57,7 +57,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createTagRequestBody** | [**CreateTagRequestBody**](../../docs/\models/CreateTagRequestBody.md) | | | +| **createTagRequestBody** | [**CreateTagRequestBody**](../../docs//models/CreateTagRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type diff --git a/docs/apis/WarehousesApi.md b/docs/apis/WarehousesApi.md index 7a4621f..07ddd9d 100644 --- a/docs/apis/WarehousesApi.md +++ b/docs/apis/WarehousesApi.md @@ -58,7 +58,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createWarehouseRequestBody** | [**CreateWarehouseRequestBody**](../../docs/\models/CreateWarehouseRequestBody.md) | | | +| **createWarehouseRequestBody** | [**CreateWarehouseRequestBody**](../../docs//models/CreateWarehouseRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -281,7 +281,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateWarehouseRequestBody** | [**UpdateWarehouseRequestBody**](../../docs/\models/UpdateWarehouseRequestBody.md) | | | +| **updateWarehouseRequestBody** | [**UpdateWarehouseRequestBody**](../../docs//models/UpdateWarehouseRequestBody.md) | | | | **warehouseId** | **string** | Warehouse ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | @@ -339,7 +339,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateWarehouseSettingsRequestBody** | [**UpdateWarehouseSettingsRequestBody**](../../docs/\models/UpdateWarehouseSettingsRequestBody.md) | | | +| **updateWarehouseSettingsRequestBody** | [**UpdateWarehouseSettingsRequestBody**](../../docs//models/UpdateWarehouseSettingsRequestBody.md) | | | | **warehouseId** | **string** | Warehouse ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/docs/apis/WebhooksApi.md b/docs/apis/WebhooksApi.md index 37d7200..8638f7b 100644 --- a/docs/apis/WebhooksApi.md +++ b/docs/apis/WebhooksApi.md @@ -57,7 +57,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **createWebhookRequestBody** | [**CreateWebhookRequestBody**](../../docs/\models/CreateWebhookRequestBody.md) | | | +| **createWebhookRequestBody** | [**CreateWebhookRequestBody**](../../docs//models/CreateWebhookRequestBody.md) | | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | ### Return type @@ -280,7 +280,7 @@ namespace Example | Name | Type | Description | Notes | |------|------|-------------|-------| | **methodClient** | [**HttpClient**](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netstandard-2.0) | The HttpClient instance to use for the request. | | -| **updateWebhookRequestBody** | [**UpdateWebhookRequestBody**](../../docs/\models/UpdateWebhookRequestBody.md) | | | +| **updateWebhookRequestBody** | [**UpdateWebhookRequestBody**](../../docs//models/UpdateWebhookRequestBody.md) | | | | **webhookId** | **string** | Webhook ID | | | **cancellationToken** | [**CancellationToken**](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=netstandard-2.0) | The cancellation token to use for the request. | | diff --git a/openapitools.json b/openapitools.json index a5e67e6..8113751 100644 --- a/openapitools.json +++ b/openapitools.json @@ -14,7 +14,7 @@ "ignoreFileOverride": "./.openapi-generator-ignore", "library": "generichost", "additionalProperties": { - "packageVersion": "3.0.1", + "packageVersion": "3.1.0", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "",